From cec5a9a3cc91886646df08ca4318b9d36a61f828 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sat, 6 Oct 2018 16:40:40 +0200 Subject: [PATCH 1/9] Docs renames (& removal for re-gen) --- docs/api-observable/README.md | 8 - docs/api-observable/SUMMARY.md | 15 - docs/api-observable/classes/_base_.apibase.md | 188 --- .../classes/_calls_.apicalls.md | 722 ----------- .../classes/_classes_.rxproposal.md | 324 ----- .../classes/_classes_.rxproposaldeposits.md | 313 ----- .../classes/_classes_.rxreferendum.md | 336 ------ .../classes/_combined_.apicombined.md | 1017 ---------------- docs/api-observable/classes/_index_.api.md | 1055 ----------------- .../classes/_queries_.apiqueries.md | 577 --------- docs/api-observable/modules/_base_.md | 10 - docs/api-observable/modules/_calls_.md | 10 - docs/api-observable/modules/_classes_.md | 12 - docs/api-observable/modules/_combined_.md | 10 - docs/api-observable/modules/_index_.md | 10 - docs/api-observable/modules/_queries_.md | 10 - docs/api-observable/modules/_types_d_.md | 61 - docs/api-provider/README.md | 28 - docs/api-provider/SUMMARY.md | 23 - .../classes/_http_index_.httpprovider.html | 623 ---------- .../classes/_http_index_.httpprovider.md | 159 --- .../classes/_ws_index_.wsprovider.html | 904 -------------- .../classes/_ws_index_.wsprovider.md | 392 ------ docs/api-provider/index.html | 465 -------- .../interfaces/_types_d_.providerinterface.md | 99 -- ...rovider.eventemitter.eventemitterstatic.md | 24 - ...dex_.wsprovider.eventemitter.listenerfn.md | 19 - .../modules/_coder_json_decoderesponse_.md | 23 - .../modules/_coder_json_encodejson_.md | 24 - .../modules/_coder_json_encodeobject_.md | 24 - .../modules/_coder_json_index_.md | 16 - .../modules/_coder_json_types_d_.md | 27 - docs/api-provider/modules/_http_index_.md | 10 - docs/api-provider/modules/_http_polyfill_.md | 2 - docs/api-provider/modules/_http_types_d_.md | 16 - docs/api-provider/modules/_index_.md | 2 - docs/api-provider/modules/_mock_index_.md | 19 - docs/api-provider/modules/_mock_mocks_.md | 22 - docs/api-provider/modules/_mock_on_.md | 24 - docs/api-provider/modules/_mock_send_.md | 24 - docs/api-provider/modules/_mock_state_.md | 16 - docs/api-provider/modules/_mock_subscribe_.md | 25 - docs/api-provider/modules/_mock_types_d_.md | 87 -- .../modules/_mock_unsubscribe_.md | 25 - docs/api-provider/modules/_types_d_.md | 108 -- docs/api-provider/modules/_ws_index_.md | 10 - .../_ws_index_.wsprovider.eventemitter.md | 27 - docs/api-provider/modules/_ws_polyfill_.md | 2 - docs/api-rx/README.md | 8 - docs/api-rx/SUMMARY.md | 4 - docs/api-rx/classes/_index_.rxapi.html | 521 -------- docs/api-rx/classes/_index_.rxapi.md | 98 -- docs/api-rx/index.html | 454 ------- docs/api-rx/modules/_defaults_.md | 2 - docs/api-rx/modules/_index_.md | 10 - docs/api-rx/modules/_types_d_.md | 49 - docs/api/README.md | 72 -- docs/api/SUMMARY.md | 4 - docs/api/classes/_index_.api.html | 543 --------- docs/api/classes/_index_.api.md | 119 -- docs/api/index.html | 500 -------- .../_types_d_.apiinterface_section_method.md | 51 - docs/api/modules/_index_.md | 10 - docs/api/modules/_types_d_.md | 29 - docs/examples/01_simple_connect/index.js | 6 +- docs/examples/01_simple_connect/package.json | 4 +- docs/examples/02_listen_to_blocks/index.js | 6 +- .../examples/02_listen_to_blocks/package.json | 2 +- .../03_listen_to_balance_change/index.js | 7 +- .../03_listen_to_balance_change/package.json | 2 +- .../examples/04_generate_account/package.json | 2 +- docs/examples/05_read_storage/index.js | 6 +- docs/examples/05_read_storage/package.json | 2 +- docs/examples/06_craft_extrinsic/index.js | 6 +- docs/examples/06_craft_extrinsic/package.json | 2 +- docs/examples/07_transfer_dots/index.js | 6 +- docs/examples/07_transfer_dots/package.json | 2 +- docs/guides/create_api.adoc | 8 - docs/guides/create_api.md | 8 + docs/types/README.md | 6 - docs/types/SUMMARY.md | 158 --- docs/types/classes/_accountid_.accountid.md | 223 ---- .../classes/_accountindex_.accountindex.md | 227 ---- docs/types/classes/_address_.address.md | 161 --- .../classes/_authorityid_.authorityid.md | 235 ---- docs/types/classes/_balance_.balance.md | 399 ------- .../classes/_bft_.bftauthoritysignature.md | 315 ----- docs/types/classes/_bft_.bfthashsignature.md | 315 ----- docs/types/classes/_bft_.justification.md | 324 ----- docs/types/classes/_block_.block.md | 324 ----- .../classes/_blocknumber_.blocknumber.md | 399 ------- docs/types/classes/_bool_.bool.md | 143 --- docs/types/classes/_bytes_.bytes.md | 184 --- docs/types/classes/_codec_base_.base.md | 151 --- docs/types/classes/_codec_compact_.compact.md | 45 - docs/types/classes/_codec_enum_.enum.md | 161 --- .../classes/_codec_enumtype_.enumtype.md | 194 --- docs/types/classes/_codec_option_.option.md | 191 --- docs/types/classes/_codec_struct_.struct.md | 320 ----- docs/types/classes/_codec_tuple_.tuple.md | 295 ----- docs/types/classes/_codec_u8a_.u8a.md | 174 --- .../classes/_codec_u8afixed_.u8afixed.md | 198 ---- docs/types/classes/_codec_uint_.uint.md | 371 ------ docs/types/classes/_codec_vector_.vector.md | 319 ----- docs/types/classes/_extrinsic_.extrinsic.md | 410 ------- .../classes/_extrinsicera_.extrinsicera.md | 195 --- docs/types/classes/_extrinsics_.extrinsics.md | 353 ------ ..._extrinsicsignature_.extrinsicsignature.md | 372 ------ docs/types/classes/_gas_.gas.md | 399 ------- docs/types/classes/_h256_.h256.md | 197 --- docs/types/classes/_h512_.h512.md | 197 --- docs/types/classes/_hash_.hash.md | 197 --- docs/types/classes/_header_.digest.md | 302 ----- docs/types/classes/_header_.header.md | 357 ------ docs/types/classes/_keyvalue_.keyvalue.md | 313 ----- .../classes/_keyvalue_.keyvalueoption.md | 315 ----- docs/types/classes/_metadata_.callmetadata.md | 313 ----- .../types/classes/_metadata_.eventmetadata.md | 324 ----- .../_metadata_.functionargumentmetadata.md | 313 ----- .../classes/_metadata_.functionmetadata.md | 335 ------ .../classes/_metadata_.modulemetadata.md | 313 ----- .../classes/_metadata_.outereventmetadata.md | 313 ----- .../_metadata_.outereventmetadataevent.md | 313 ----- .../classes/_metadata_.runtimemetadata.md | 320 ----- .../_metadata_.runtimemodulemetadata.md | 324 ----- .../_metadata_.storagefunctionmetadata.md | 335 ------ .../_metadata_.storagefunctionmodifier.md | 168 --- .../classes/_metadata_.storagefunctiontype.md | 232 ---- .../_metadata_.storagefunctiontype_map.md | 313 ----- .../classes/_metadata_.storagemetadata.md | 313 ----- docs/types/classes/_method_.method.md | 356 ------ .../classes/_methodindex_.methodindex.md | 230 ---- .../_misbehaviorreport_.bftatreport.md | 328 ----- .../_misbehaviorreport_.bftdoublecommit.md | 332 ------ .../_misbehaviorreport_.bftdoubleprepare.md | 332 ------ .../_misbehaviorreport_.misbehaviorkind.md | 201 ---- .../_misbehaviorreport_.misbehaviorreport.md | 335 ------ docs/types/classes/_moment_.moment.md | 193 --- .../_newaccountoutcome_.newaccountoutcome.md | 168 --- docs/types/classes/_nonce_.index.md | 399 ------- docs/types/classes/_origin_.origin.md | 139 --- .../classes/_parachainid_.parachainid.md | 399 ------- .../_pendingextrinsics_.pendingextrinsics.md | 351 ------ docs/types/classes/_perbill_.perbill.md | 399 ------- docs/types/classes/_permill_.permill.md | 399 ------- docs/types/classes/_propindex_.propindex.md | 399 ------- docs/types/classes/_proposal_.proposal.md | 431 ------- .../classes/_proposalindex_.proposalindex.md | 399 ------- .../_referendumindex_.referendumindex.md | 399 ------- .../_runtimeversion_.runtimeversion.md | 357 ------ docs/types/classes/_signature_.signature.md | 197 --- .../_signaturepayload_.signaturepayload.md | 383 ------ .../classes/_signedblock_.signedblock.md | 313 ----- .../_storagechangeset_.storagechangeset.md | 313 ----- .../classes/_storagedata_.storagedata.md | 188 --- docs/types/classes/_storagekey_.storagekey.md | 231 ---- docs/types/classes/_text_.text.md | 159 --- docs/types/classes/_type_.type.md | 165 --- docs/types/classes/_u128_.u128.md | 399 ------- docs/types/classes/_u16_.u16.md | 397 ------- docs/types/classes/_u256_.u256.md | 397 ------- docs/types/classes/_u32_.u32.md | 409 ------- docs/types/classes/_u64_.u64.md | 405 ------- docs/types/classes/_u8_.u8.md | 397 ------- .../_validatorprefs_.validatorprefs.md | 313 ----- docs/types/classes/_voteindex_.voteindex.md | 399 ------- .../classes/_votethreshold_.votethreshold.md | 168 --- .../enums/_codec_createtype_.typedefinfo.md | 42 - .../_storagekey_.storagefunction.md | 63 - docs/types/modules/_accountid_.md | 10 - docs/types/modules/_accountindex_.md | 10 - docs/types/modules/_address_.md | 10 - docs/types/modules/_authorityid_.md | 10 - docs/types/modules/_balance_.md | 10 - docs/types/modules/_bft_.md | 54 - docs/types/modules/_block_.md | 28 - docs/types/modules/_blocknumber_.md | 10 - docs/types/modules/_bool_.md | 10 - docs/types/modules/_bytes_.md | 10 - docs/types/modules/_codec_base_.md | 28 - docs/types/modules/_codec_compact_.md | 10 - docs/types/modules/_codec_createtype_.md | 107 -- docs/types/modules/_codec_enum_.md | 10 - docs/types/modules/_codec_enumtype_.md | 10 - docs/types/modules/_codec_index_.md | 2 - docs/types/modules/_codec_option_.md | 10 - docs/types/modules/_codec_struct_.md | 10 - docs/types/modules/_codec_tuple_.md | 10 - docs/types/modules/_codec_u8a_.md | 10 - docs/types/modules/_codec_u8afixed_.md | 10 - docs/types/modules/_codec_uint_.md | 10 - docs/types/modules/_codec_vector_.md | 10 - docs/types/modules/_extrinsic_.md | 10 - docs/types/modules/_extrinsicera_.md | 10 - docs/types/modules/_extrinsics_.md | 10 - docs/types/modules/_extrinsicsignature_.md | 10 - docs/types/modules/_gas_.md | 10 - docs/types/modules/_h256_.md | 10 - docs/types/modules/_h512_.md | 10 - docs/types/modules/_hash_.md | 10 - docs/types/modules/_header_.md | 29 - docs/types/modules/_index_.md | 2 - docs/types/modules/_keyvalue_.md | 29 - docs/types/modules/_metadata_.md | 23 - docs/types/modules/_metadata_rpc_.md | 2 - docs/types/modules/_method_.md | 10 - docs/types/modules/_methodindex_.md | 10 - docs/types/modules/_misbehaviorreport_.md | 14 - docs/types/modules/_moment_.md | 10 - docs/types/modules/_newaccountoutcome_.md | 10 - docs/types/modules/_nonce_.md | 10 - docs/types/modules/_origin_.md | 10 - docs/types/modules/_parachainid_.md | 10 - docs/types/modules/_pendingextrinsics_.md | 10 - docs/types/modules/_perbill_.md | 10 - docs/types/modules/_permill_.md | 10 - docs/types/modules/_propindex_.md | 10 - docs/types/modules/_proposal_.md | 10 - docs/types/modules/_proposalindex_.md | 10 - docs/types/modules/_referendumindex_.md | 10 - docs/types/modules/_runtimeversion_.md | 10 - docs/types/modules/_signature_.md | 10 - docs/types/modules/_signaturepayload_.md | 10 - docs/types/modules/_signedblock_.md | 10 - docs/types/modules/_storagechangeset_.md | 10 - docs/types/modules/_storagedata_.md | 10 - docs/types/modules/_storagekey_.md | 14 - docs/types/modules/_text_.md | 10 - docs/types/modules/_type_.md | 10 - docs/types/modules/_types_d_.md | 34 - docs/types/modules/_u128_.md | 10 - docs/types/modules/_u16_.md | 10 - docs/types/modules/_u256_.md | 10 - docs/types/modules/_u32_.md | 10 - docs/types/modules/_u64_.md | 10 - docs/types/modules/_u8_.md | 10 - docs/types/modules/_validatorprefs_.md | 10 - docs/types/modules/_voteindex_.md | 10 - docs/types/modules/_votethreshold_.md | 10 - 239 files changed, 35 insertions(+), 36943 deletions(-) delete mode 100644 docs/api-observable/README.md delete mode 100644 docs/api-observable/SUMMARY.md delete mode 100644 docs/api-observable/classes/_base_.apibase.md delete mode 100644 docs/api-observable/classes/_calls_.apicalls.md delete mode 100644 docs/api-observable/classes/_classes_.rxproposal.md delete mode 100644 docs/api-observable/classes/_classes_.rxproposaldeposits.md delete mode 100644 docs/api-observable/classes/_classes_.rxreferendum.md delete mode 100644 docs/api-observable/classes/_combined_.apicombined.md delete mode 100644 docs/api-observable/classes/_index_.api.md delete mode 100644 docs/api-observable/classes/_queries_.apiqueries.md delete mode 100644 docs/api-observable/modules/_base_.md delete mode 100644 docs/api-observable/modules/_calls_.md delete mode 100644 docs/api-observable/modules/_classes_.md delete mode 100644 docs/api-observable/modules/_combined_.md delete mode 100644 docs/api-observable/modules/_index_.md delete mode 100644 docs/api-observable/modules/_queries_.md delete mode 100644 docs/api-observable/modules/_types_d_.md delete mode 100644 docs/api-provider/README.md delete mode 100644 docs/api-provider/SUMMARY.md delete mode 100644 docs/api-provider/classes/_http_index_.httpprovider.html delete mode 100644 docs/api-provider/classes/_http_index_.httpprovider.md delete mode 100644 docs/api-provider/classes/_ws_index_.wsprovider.html delete mode 100644 docs/api-provider/classes/_ws_index_.wsprovider.md delete mode 100644 docs/api-provider/index.html delete mode 100644 docs/api-provider/interfaces/_types_d_.providerinterface.md delete mode 100644 docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md delete mode 100644 docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md delete mode 100644 docs/api-provider/modules/_coder_json_decoderesponse_.md delete mode 100644 docs/api-provider/modules/_coder_json_encodejson_.md delete mode 100644 docs/api-provider/modules/_coder_json_encodeobject_.md delete mode 100644 docs/api-provider/modules/_coder_json_index_.md delete mode 100644 docs/api-provider/modules/_coder_json_types_d_.md delete mode 100644 docs/api-provider/modules/_http_index_.md delete mode 100644 docs/api-provider/modules/_http_polyfill_.md delete mode 100644 docs/api-provider/modules/_http_types_d_.md delete mode 100644 docs/api-provider/modules/_index_.md delete mode 100644 docs/api-provider/modules/_mock_index_.md delete mode 100644 docs/api-provider/modules/_mock_mocks_.md delete mode 100644 docs/api-provider/modules/_mock_on_.md delete mode 100644 docs/api-provider/modules/_mock_send_.md delete mode 100644 docs/api-provider/modules/_mock_state_.md delete mode 100644 docs/api-provider/modules/_mock_subscribe_.md delete mode 100644 docs/api-provider/modules/_mock_types_d_.md delete mode 100644 docs/api-provider/modules/_mock_unsubscribe_.md delete mode 100644 docs/api-provider/modules/_types_d_.md delete mode 100644 docs/api-provider/modules/_ws_index_.md delete mode 100644 docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md delete mode 100644 docs/api-provider/modules/_ws_polyfill_.md delete mode 100644 docs/api-rx/README.md delete mode 100644 docs/api-rx/SUMMARY.md delete mode 100644 docs/api-rx/classes/_index_.rxapi.html delete mode 100644 docs/api-rx/classes/_index_.rxapi.md delete mode 100644 docs/api-rx/index.html delete mode 100644 docs/api-rx/modules/_defaults_.md delete mode 100644 docs/api-rx/modules/_index_.md delete mode 100644 docs/api-rx/modules/_types_d_.md delete mode 100644 docs/api/README.md delete mode 100644 docs/api/SUMMARY.md delete mode 100644 docs/api/classes/_index_.api.html delete mode 100644 docs/api/classes/_index_.api.md delete mode 100644 docs/api/index.html delete mode 100644 docs/api/interfaces/_types_d_.apiinterface_section_method.md delete mode 100644 docs/api/modules/_index_.md delete mode 100644 docs/api/modules/_types_d_.md delete mode 100644 docs/guides/create_api.adoc create mode 100644 docs/guides/create_api.md delete mode 100644 docs/types/README.md delete mode 100644 docs/types/SUMMARY.md delete mode 100644 docs/types/classes/_accountid_.accountid.md delete mode 100644 docs/types/classes/_accountindex_.accountindex.md delete mode 100644 docs/types/classes/_address_.address.md delete mode 100644 docs/types/classes/_authorityid_.authorityid.md delete mode 100644 docs/types/classes/_balance_.balance.md delete mode 100644 docs/types/classes/_bft_.bftauthoritysignature.md delete mode 100644 docs/types/classes/_bft_.bfthashsignature.md delete mode 100644 docs/types/classes/_bft_.justification.md delete mode 100644 docs/types/classes/_block_.block.md delete mode 100644 docs/types/classes/_blocknumber_.blocknumber.md delete mode 100644 docs/types/classes/_bool_.bool.md delete mode 100644 docs/types/classes/_bytes_.bytes.md delete mode 100644 docs/types/classes/_codec_base_.base.md delete mode 100644 docs/types/classes/_codec_compact_.compact.md delete mode 100644 docs/types/classes/_codec_enum_.enum.md delete mode 100644 docs/types/classes/_codec_enumtype_.enumtype.md delete mode 100644 docs/types/classes/_codec_option_.option.md delete mode 100644 docs/types/classes/_codec_struct_.struct.md delete mode 100644 docs/types/classes/_codec_tuple_.tuple.md delete mode 100644 docs/types/classes/_codec_u8a_.u8a.md delete mode 100644 docs/types/classes/_codec_u8afixed_.u8afixed.md delete mode 100644 docs/types/classes/_codec_uint_.uint.md delete mode 100644 docs/types/classes/_codec_vector_.vector.md delete mode 100644 docs/types/classes/_extrinsic_.extrinsic.md delete mode 100644 docs/types/classes/_extrinsicera_.extrinsicera.md delete mode 100644 docs/types/classes/_extrinsics_.extrinsics.md delete mode 100644 docs/types/classes/_extrinsicsignature_.extrinsicsignature.md delete mode 100644 docs/types/classes/_gas_.gas.md delete mode 100644 docs/types/classes/_h256_.h256.md delete mode 100644 docs/types/classes/_h512_.h512.md delete mode 100644 docs/types/classes/_hash_.hash.md delete mode 100644 docs/types/classes/_header_.digest.md delete mode 100644 docs/types/classes/_header_.header.md delete mode 100644 docs/types/classes/_keyvalue_.keyvalue.md delete mode 100644 docs/types/classes/_keyvalue_.keyvalueoption.md delete mode 100644 docs/types/classes/_metadata_.callmetadata.md delete mode 100644 docs/types/classes/_metadata_.eventmetadata.md delete mode 100644 docs/types/classes/_metadata_.functionargumentmetadata.md delete mode 100644 docs/types/classes/_metadata_.functionmetadata.md delete mode 100644 docs/types/classes/_metadata_.modulemetadata.md delete mode 100644 docs/types/classes/_metadata_.outereventmetadata.md delete mode 100644 docs/types/classes/_metadata_.outereventmetadataevent.md delete mode 100644 docs/types/classes/_metadata_.runtimemetadata.md delete mode 100644 docs/types/classes/_metadata_.runtimemodulemetadata.md delete mode 100644 docs/types/classes/_metadata_.storagefunctionmetadata.md delete mode 100644 docs/types/classes/_metadata_.storagefunctionmodifier.md delete mode 100644 docs/types/classes/_metadata_.storagefunctiontype.md delete mode 100644 docs/types/classes/_metadata_.storagefunctiontype_map.md delete mode 100644 docs/types/classes/_metadata_.storagemetadata.md delete mode 100644 docs/types/classes/_method_.method.md delete mode 100644 docs/types/classes/_methodindex_.methodindex.md delete mode 100644 docs/types/classes/_misbehaviorreport_.bftatreport.md delete mode 100644 docs/types/classes/_misbehaviorreport_.bftdoublecommit.md delete mode 100644 docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md delete mode 100644 docs/types/classes/_misbehaviorreport_.misbehaviorkind.md delete mode 100644 docs/types/classes/_misbehaviorreport_.misbehaviorreport.md delete mode 100644 docs/types/classes/_moment_.moment.md delete mode 100644 docs/types/classes/_newaccountoutcome_.newaccountoutcome.md delete mode 100644 docs/types/classes/_nonce_.index.md delete mode 100644 docs/types/classes/_origin_.origin.md delete mode 100644 docs/types/classes/_parachainid_.parachainid.md delete mode 100644 docs/types/classes/_pendingextrinsics_.pendingextrinsics.md delete mode 100644 docs/types/classes/_perbill_.perbill.md delete mode 100644 docs/types/classes/_permill_.permill.md delete mode 100644 docs/types/classes/_propindex_.propindex.md delete mode 100644 docs/types/classes/_proposal_.proposal.md delete mode 100644 docs/types/classes/_proposalindex_.proposalindex.md delete mode 100644 docs/types/classes/_referendumindex_.referendumindex.md delete mode 100644 docs/types/classes/_runtimeversion_.runtimeversion.md delete mode 100644 docs/types/classes/_signature_.signature.md delete mode 100644 docs/types/classes/_signaturepayload_.signaturepayload.md delete mode 100644 docs/types/classes/_signedblock_.signedblock.md delete mode 100644 docs/types/classes/_storagechangeset_.storagechangeset.md delete mode 100644 docs/types/classes/_storagedata_.storagedata.md delete mode 100644 docs/types/classes/_storagekey_.storagekey.md delete mode 100644 docs/types/classes/_text_.text.md delete mode 100644 docs/types/classes/_type_.type.md delete mode 100644 docs/types/classes/_u128_.u128.md delete mode 100644 docs/types/classes/_u16_.u16.md delete mode 100644 docs/types/classes/_u256_.u256.md delete mode 100644 docs/types/classes/_u32_.u32.md delete mode 100644 docs/types/classes/_u64_.u64.md delete mode 100644 docs/types/classes/_u8_.u8.md delete mode 100644 docs/types/classes/_validatorprefs_.validatorprefs.md delete mode 100644 docs/types/classes/_voteindex_.voteindex.md delete mode 100644 docs/types/classes/_votethreshold_.votethreshold.md delete mode 100644 docs/types/enums/_codec_createtype_.typedefinfo.md delete mode 100644 docs/types/interfaces/_storagekey_.storagefunction.md delete mode 100644 docs/types/modules/_accountid_.md delete mode 100644 docs/types/modules/_accountindex_.md delete mode 100644 docs/types/modules/_address_.md delete mode 100644 docs/types/modules/_authorityid_.md delete mode 100644 docs/types/modules/_balance_.md delete mode 100644 docs/types/modules/_bft_.md delete mode 100644 docs/types/modules/_block_.md delete mode 100644 docs/types/modules/_blocknumber_.md delete mode 100644 docs/types/modules/_bool_.md delete mode 100644 docs/types/modules/_bytes_.md delete mode 100644 docs/types/modules/_codec_base_.md delete mode 100644 docs/types/modules/_codec_compact_.md delete mode 100644 docs/types/modules/_codec_createtype_.md delete mode 100644 docs/types/modules/_codec_enum_.md delete mode 100644 docs/types/modules/_codec_enumtype_.md delete mode 100644 docs/types/modules/_codec_index_.md delete mode 100644 docs/types/modules/_codec_option_.md delete mode 100644 docs/types/modules/_codec_struct_.md delete mode 100644 docs/types/modules/_codec_tuple_.md delete mode 100644 docs/types/modules/_codec_u8a_.md delete mode 100644 docs/types/modules/_codec_u8afixed_.md delete mode 100644 docs/types/modules/_codec_uint_.md delete mode 100644 docs/types/modules/_codec_vector_.md delete mode 100644 docs/types/modules/_extrinsic_.md delete mode 100644 docs/types/modules/_extrinsicera_.md delete mode 100644 docs/types/modules/_extrinsics_.md delete mode 100644 docs/types/modules/_extrinsicsignature_.md delete mode 100644 docs/types/modules/_gas_.md delete mode 100644 docs/types/modules/_h256_.md delete mode 100644 docs/types/modules/_h512_.md delete mode 100644 docs/types/modules/_hash_.md delete mode 100644 docs/types/modules/_header_.md delete mode 100644 docs/types/modules/_index_.md delete mode 100644 docs/types/modules/_keyvalue_.md delete mode 100644 docs/types/modules/_metadata_.md delete mode 100644 docs/types/modules/_metadata_rpc_.md delete mode 100644 docs/types/modules/_method_.md delete mode 100644 docs/types/modules/_methodindex_.md delete mode 100644 docs/types/modules/_misbehaviorreport_.md delete mode 100644 docs/types/modules/_moment_.md delete mode 100644 docs/types/modules/_newaccountoutcome_.md delete mode 100644 docs/types/modules/_nonce_.md delete mode 100644 docs/types/modules/_origin_.md delete mode 100644 docs/types/modules/_parachainid_.md delete mode 100644 docs/types/modules/_pendingextrinsics_.md delete mode 100644 docs/types/modules/_perbill_.md delete mode 100644 docs/types/modules/_permill_.md delete mode 100644 docs/types/modules/_propindex_.md delete mode 100644 docs/types/modules/_proposal_.md delete mode 100644 docs/types/modules/_proposalindex_.md delete mode 100644 docs/types/modules/_referendumindex_.md delete mode 100644 docs/types/modules/_runtimeversion_.md delete mode 100644 docs/types/modules/_signature_.md delete mode 100644 docs/types/modules/_signaturepayload_.md delete mode 100644 docs/types/modules/_signedblock_.md delete mode 100644 docs/types/modules/_storagechangeset_.md delete mode 100644 docs/types/modules/_storagedata_.md delete mode 100644 docs/types/modules/_storagekey_.md delete mode 100644 docs/types/modules/_text_.md delete mode 100644 docs/types/modules/_type_.md delete mode 100644 docs/types/modules/_types_d_.md delete mode 100644 docs/types/modules/_u128_.md delete mode 100644 docs/types/modules/_u16_.md delete mode 100644 docs/types/modules/_u256_.md delete mode 100644 docs/types/modules/_u32_.md delete mode 100644 docs/types/modules/_u64_.md delete mode 100644 docs/types/modules/_u8_.md delete mode 100644 docs/types/modules/_validatorprefs_.md delete mode 100644 docs/types/modules/_voteindex_.md delete mode 100644 docs/types/modules/_votethreshold_.md diff --git a/docs/api-observable/README.md b/docs/api-observable/README.md deleted file mode 100644 index 29ffd72c7b1a..000000000000 --- a/docs/api-observable/README.md +++ /dev/null @@ -1,8 +0,0 @@ - -[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-observable.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-observable) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable#info=devDependencies) - -@polkadot/api-observable -======================== - -An RxJs wrapper around the [@polkadot/api](../api). - diff --git a/docs/api-observable/SUMMARY.md b/docs/api-observable/SUMMARY.md deleted file mode 100644 index 0532061d7428..000000000000 --- a/docs/api-observable/SUMMARY.md +++ /dev/null @@ -1,15 +0,0 @@ -* ["Base"](modules/_base_.md) - * [ApiBase](classes/_base_.apibase.md) -* ["Calls"](modules/_calls_.md) - * [ApiCalls](classes/_calls_.apicalls.md) -* ["Combined"](modules/_combined_.md) - * [ApiCombined](classes/_combined_.apicombined.md) -* ["Queries"](modules/_queries_.md) - * [ApiQueries](classes/_queries_.apiqueries.md) -* ["classes"](modules/_classes_.md) - * [RxProposal](classes/_classes_.rxproposal.md) - * [RxProposalDeposits](classes/_classes_.rxproposaldeposits.md) - * [RxReferendum](classes/_classes_.rxreferendum.md) -* ["index"](modules/_index_.md) - * [Api](classes/_index_.api.md) -* ["types.d"](modules/_types_d_.md) diff --git a/docs/api-observable/classes/_base_.apibase.md b/docs/api-observable/classes/_base_.apibase.md deleted file mode 100644 index 71ec01d5f13b..000000000000 --- a/docs/api-observable/classes/_base_.apibase.md +++ /dev/null @@ -1,188 +0,0 @@ - - -# Hierarchy - -**ApiBase** - -↳ [ApiQueries](_queries_.apiqueries.md) - -# Constructors - - - -## constructor - -⊕ **new ApiBase**(api: *`RxApiInterface`*): [ApiBase](_base_.apibase.md) - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| api | `RxApiInterface` | - -**Returns:** [ApiBase](_base_.apibase.md) - -___ - -# Properties - - - -## `` _api - -**● _api**: *`RxApiInterface`* - -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L28)* - -___ - - -## `` _genesisHash - -**● _genesisHash**: *`Hash`* - -*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L29)* - -___ - - -## whenReady - -**● whenReady**: *`Observable`<`boolean`>* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -___ - - -## `` extrinsics - -**● extrinsics**: *`Extrinsics`* = extrinsicsStatic - -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L40)* - -___ - - -## `` storage - -**● storage**: *`Storage`* = storageStatic - -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L41)* - -___ - -# Accessors - - - -## genesisHash - -getgenesisHash(): `Hash` - -*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L78)* - -**Returns:** `Hash` - -___ - -# Methods - - - -## `` combine - -▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> - -*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L71)* - -**Type parameters:** - -#### T -#### R -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| observables | `Array`<`Observable`<`any`>> | - | -| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn | - -**Returns:** `Observable`<`T`> - -___ - - -## isConnected - -▸ **isConnected**(): `Observable`<`boolean`> - -*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L82)* - -**Returns:** `Observable`<`boolean`> - -___ - - -## rawCall - -▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> - -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L86)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`T`> - -___ - - -## rawStorage - -▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> - -*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L98)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| key | `StorageFunction` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`< `T` | `undefined`> - -___ - - -## rawStorageMulti - -▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> - -*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L110)* - -**Type parameters:** - -#### T : `[]` -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> | - -**Returns:** `Observable`<`T`> - -___ - diff --git a/docs/api-observable/classes/_calls_.apicalls.md b/docs/api-observable/classes/_calls_.apicalls.md deleted file mode 100644 index 9662564e46f6..000000000000 --- a/docs/api-observable/classes/_calls_.apicalls.md +++ /dev/null @@ -1,722 +0,0 @@ - - -# Hierarchy - -↳ [ApiQueries](_queries_.apiqueries.md) - -**↳ ApiCalls** - -↳ [ApiCombined](_combined_.apicombined.md) - -# Constructors - - - -## constructor - -⊕ **new ApiCalls**(api: *`RxApiInterface`*): [ApiCalls](_calls_.apicalls.md) - -*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| api | `RxApiInterface` | - -**Returns:** [ApiCalls](_calls_.apicalls.md) - -___ - -# Properties - - - -## `` _api - -**● _api**: *`RxApiInterface`* - -*Inherited from [ApiBase](_base_.apibase.md).[_api](_base_.apibase.md#_api)* - -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L28)* - -___ - - -## `` _genesisHash - -**● _genesisHash**: *`Hash`* - -*Inherited from [ApiBase](_base_.apibase.md).[_genesisHash](_base_.apibase.md#_genesishash)* - -*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L29)* - -___ - - -## whenReady - -**● whenReady**: *`Observable`<`boolean`>* - -*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -___ - - -## `` extrinsics - -**● extrinsics**: *`Extrinsics`* = extrinsicsStatic - -*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* - -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L40)* - -___ - - -## `` storage - -**● storage**: *`Storage`* = storageStatic - -*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* - -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L41)* - -___ - -# Accessors - - - -## genesisHash - -getgenesisHash(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L78)* - -**Returns:** `Hash` - -___ - -# Methods - - - -## accountNonce - -▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* - -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Index` | `undefined`> - -___ - - -## balanceFree - -▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* - -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L23)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## balanceReserved - -▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* - -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## bestNumber - -▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L13)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## blockNow - -▸ **blockNow**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* - -*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L35)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## blockPeriod - -▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* - -*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L31)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## chain - -▸ **chain**(): `Observable`< `Text` | `undefined`> - -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L25)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## `` combine - -▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* - -*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L71)* - -**Type parameters:** - -#### T -#### R -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| observables | `Array`<`Observable`<`any`>> | - | -| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn | - -**Returns:** `Observable`<`T`> - -___ - - -## democracyLaunchPeriod - -▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* - -*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L39)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## democracyNextTally - -▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* - -*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L43)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## democracyVotingPeriod - -▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* - -*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L111)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraLastLengthChange - -▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* - -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L136)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## fees - -▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* - -*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L115)* - -**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -___ - - -## getBlock - -▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> - -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| hash | `Uint8Array` | - -**Returns:** `Observable`< `SignedBlock` | `undefined`> - -___ - - -## isConnected - -▸ **isConnected**(): `Observable`<`boolean`> - -*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* - -*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L82)* - -**Returns:** `Observable`<`boolean`> - -___ - - -## newHead - -▸ **newHead**(): `Observable`< `Header` | `undefined`> - -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L33)* - -**Returns:** `Observable`< `Header` | `undefined`> - -___ - - -## proposalDeposits - -▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* - -*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| proposalId | `PropIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -___ - - -## publicProposals - -▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* - -*Defined in [Queries.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L60)* - -**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -___ - - -## rawCall - -▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* - -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L86)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`T`> - -___ - - -## rawStorage - -▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* - -*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L98)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| key | `StorageFunction` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`< `T` | `undefined`> - -___ - - -## rawStorageMulti - -▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* - -*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L110)* - -**Type parameters:** - -#### T : `[]` -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> | - -**Returns:** `Observable`<`T`> - -___ - - -## referendumCount - -▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* - -*Defined in [Queries.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L79)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## referendumInfo - -▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* - -*Defined in [Queries.ts:83](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L83)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -___ - - -## referendumVote - -▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* - -*Defined in [Queries.ts:96](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L96)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Bool` | `undefined`> - -___ - - -## referendumVoters - -▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* - -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L100)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionCurrentIndex - -▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* - -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L148)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionCurrentStart - -▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* - -*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L152)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionLastLengthChange - -▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* - -*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L156)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionLength - -▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* - -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L160)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionReward - -▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* - -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L140)* - -**Returns:** `Observable`< `Perbill` | `undefined`> - -___ - - -## sessionRewardCurrent - -▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* - -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L144)* - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## sessionValidators - -▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* - -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L168)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionsPerEra - -▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* - -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L164)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## stakingIntentions - -▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* - -*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L179)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## stakingNominating - -▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* - -*Defined in [Queries.ts:201](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L201)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `AccountId` | `undefined`> - -___ - - -## stakingNominatorsFor - -▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* - -*Defined in [Queries.ts:190](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L190)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## submitExtrinsic - -▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> - -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| extrinsic | `Extrinsic` | - -**Returns:** `Observable`< `Hash` | `undefined`> - -___ - - -## systemName - -▸ **systemName**(): `Observable`< `Text` | `undefined`> - -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L39)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## systemVersion - -▸ **systemVersion**(): `Observable`< `Text` | `undefined`> - -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L43)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## validatorCount - -▸ **validatorCount**(): `Observable`< `u32` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* - -*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L205)* - -**Returns:** `Observable`< `u32` | `undefined`> - -___ - diff --git a/docs/api-observable/classes/_classes_.rxproposal.md b/docs/api-observable/classes/_classes_.rxproposal.md deleted file mode 100644 index fb13c632bde0..000000000000 --- a/docs/api-observable/classes/_classes_.rxproposal.md +++ /dev/null @@ -1,324 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - - `Struct` - -**↳ RxProposal** - -# Constructors - - - -## constructor - -⊕ **new RxProposal**(value: *`Tuple`*): [RxProposal](_classes_.rxproposal.md) - -*Overrides Struct.__constructor* - -*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Tuple` | - -**Returns:** [RxProposal](_classes_.rxproposal.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from Struct._Types* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from Struct._jsonMap* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from Base.raw* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## address - -getaddress(): `AccountId` - -*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L18)* - -**Returns:** `AccountId` - -___ - - -## id - -getid(): `PropIndex` - -*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L22)* - -**Returns:** `PropIndex` - -___ - - -## proposal - -getproposal(): `Proposal` - -*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L26)* - -**Returns:** `Proposal` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from Struct.byteLength* - -*Overrides Base.byteLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromJSON* - -*Overrides Base.fromJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromU8a* - -*Overrides Base.fromU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): `Base` - -*Inherited from Struct.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Base` - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from Struct.keys* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from Struct.toJSON* - -*Overrides Base.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Overrides Base.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from Struct.toU8a* - -*Overrides Base.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<`Base`> - -*Inherited from Struct.values* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<`Base`> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from Struct.decode* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/api-observable/classes/_classes_.rxproposaldeposits.md b/docs/api-observable/classes/_classes_.rxproposaldeposits.md deleted file mode 100644 index 3d9438dce4b5..000000000000 --- a/docs/api-observable/classes/_classes_.rxproposaldeposits.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - - `Struct` - -**↳ RxProposalDeposits** - -# Constructors - - - -## constructor - -⊕ **new RxProposalDeposits**(value: *`Tuple`*): [RxProposalDeposits](_classes_.rxproposaldeposits.md) - -*Overrides Struct.__constructor* - -*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L31)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Tuple` | - -**Returns:** [RxProposalDeposits](_classes_.rxproposaldeposits.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from Struct._Types* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from Struct._jsonMap* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from Base.raw* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## addresses - -getaddresses(): `Vector`<`AccountId`> - -*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L39)* - -**Returns:** `Vector`<`AccountId`> - -___ - - -## balance - -getbalance(): `Balance` - -*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L43)* - -**Returns:** `Balance` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from Struct.byteLength* - -*Overrides Base.byteLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromJSON* - -*Overrides Base.fromJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromU8a* - -*Overrides Base.fromU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): `Base` - -*Inherited from Struct.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Base` - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from Struct.keys* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from Struct.toJSON* - -*Overrides Base.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Overrides Base.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from Struct.toU8a* - -*Overrides Base.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<`Base`> - -*Inherited from Struct.values* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<`Base`> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from Struct.decode* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/api-observable/classes/_classes_.rxreferendum.md b/docs/api-observable/classes/_classes_.rxreferendum.md deleted file mode 100644 index 593d8cff3f50..000000000000 --- a/docs/api-observable/classes/_classes_.rxreferendum.md +++ /dev/null @@ -1,336 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - - `Struct` - -**↳ RxReferendum** - -# Constructors - - - -## constructor - -⊕ **new RxReferendum**(value: *`Tuple`*, id: * `ReferendumIndex` | `BN` | `number`*): [RxReferendum](_classes_.rxreferendum.md) - -*Overrides Struct.__constructor* - -*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Tuple` | -| id | `ReferendumIndex` | `BN` | `number`| - -**Returns:** [RxReferendum](_classes_.rxreferendum.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from Struct._Types* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from Struct._jsonMap* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from Base.raw* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## blockNumber - -getblockNumber(): `BlockNumber` - -*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L58)* - -**Returns:** `BlockNumber` - -___ - - -## id - -getid(): `ReferendumIndex` - -*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L62)* - -**Returns:** `ReferendumIndex` - -___ - - -## proposal - -getproposal(): `Proposal` - -*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L66)* - -**Returns:** `Proposal` - -___ - - -## voteThreshold - -getvoteThreshold(): `VoteThreshold` - -*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/classes.ts#L70)* - -**Returns:** `VoteThreshold` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from Struct.byteLength* - -*Overrides Base.byteLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromJSON* - -*Overrides Base.fromJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): `Struct`<`S`, `T`, `V`, `E`> - -*Inherited from Struct.fromU8a* - -*Overrides Base.fromU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** `Struct`<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): `Base` - -*Inherited from Struct.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Base` - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from Struct.keys* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from Struct.toJSON* - -*Overrides Base.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Overrides Base.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from Struct.toU8a* - -*Overrides Base.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<`Base`> - -*Inherited from Struct.values* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<`Base`> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from Struct.decode* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/api-observable/classes/_combined_.apicombined.md b/docs/api-observable/classes/_combined_.apicombined.md deleted file mode 100644 index 3dbe4dbe6bed..000000000000 --- a/docs/api-observable/classes/_combined_.apicombined.md +++ /dev/null @@ -1,1017 +0,0 @@ - - -# Hierarchy - -↳ [ApiCalls](_calls_.apicalls.md) - -**↳ ApiCombined** - -↳ [Api](_index_.api.md) - -# Constructors - - - -## constructor - -⊕ **new ApiCombined**(api: *`RxApiInterface`*): [ApiCombined](_combined_.apicombined.md) - -*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| api | `RxApiInterface` | - -**Returns:** [ApiCombined](_combined_.apicombined.md) - -___ - -# Properties - - - -## `` _api - -**● _api**: *`RxApiInterface`* - -*Inherited from [ApiBase](_base_.apibase.md).[_api](_base_.apibase.md#_api)* - -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L28)* - -___ - - -## `` _genesisHash - -**● _genesisHash**: *`Hash`* - -*Inherited from [ApiBase](_base_.apibase.md).[_genesisHash](_base_.apibase.md#_genesishash)* - -*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L29)* - -___ - - -## whenReady - -**● whenReady**: *`Observable`<`boolean`>* - -*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -___ - - -## `` extrinsics - -**● extrinsics**: *`Extrinsics`* = extrinsicsStatic - -*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* - -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L40)* - -___ - - -## `` storage - -**● storage**: *`Storage`* = storageStatic - -*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* - -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L41)* - -___ - -# Accessors - - - -## genesisHash - -getgenesisHash(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L78)* - -**Returns:** `Hash` - -___ - -# Methods - - - -## accountNonce - -▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* - -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Index` | `undefined`> - -___ - - -## balanceFree - -▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* - -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L23)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## balanceReserved - -▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* - -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## bestNumber - -▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* - -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L13)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## blockNow - -▸ **blockNow**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* - -*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L35)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## blockPeriod - -▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* - -*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L31)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## chain - -▸ **chain**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* - -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L25)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## `` combine - -▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* - -*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L71)* - -**Type parameters:** - -#### T -#### R -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| observables | `Array`<`Observable`<`any`>> | - | -| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn | - -**Returns:** `Observable`<`T`> - -___ - - -## democracyLaunchPeriod - -▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* - -*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L39)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## democracyNextTally - -▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* - -*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L43)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## democracyReferendumVoters - -▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>> - -*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>> - -___ - - -## democracyVotersBalancesOf - -▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> - -*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`Balance`>> - -___ - - -## democracyVotersVotesOf - -▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> - -*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L103)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`Bool`>> - -___ - - -## democracyVotingPeriod - -▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* - -*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L111)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockLength - -▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L114)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockProgress - -▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L129)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockRemaining - -▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L151)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraLastLengthChange - -▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* - -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L136)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## fees - -▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* - -*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L115)* - -**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -___ - - -## getBlock - -▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* - -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| hash | `Uint8Array` | - -**Returns:** `Observable`< `SignedBlock` | `undefined`> - -___ - - -## isConnected - -▸ **isConnected**(): `Observable`<`boolean`> - -*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* - -*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L82)* - -**Returns:** `Observable`<`boolean`> - -___ - - -## newHead - -▸ **newHead**(): `Observable`< `Header` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[newHead](_calls_.apicalls.md#newhead)* - -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L33)* - -**Returns:** `Observable`< `Header` | `undefined`> - -___ - - -## proposalDeposits - -▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* - -*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| proposalId | `PropIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -___ - - -## publicProposalCount - -▸ **publicProposalCount**(): `Observable`<`number`> - -*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L20)* - -**Returns:** `Observable`<`number`> - -___ - - -## publicProposals - -▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* - -*Defined in [Queries.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L60)* - -**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -___ - - -## rawCall - -▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* - -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L86)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`T`> - -___ - - -## rawStorage - -▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* - -*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L98)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| key | `StorageFunction` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`< `T` | `undefined`> - -___ - - -## rawStorageMulti - -▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* - -*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L110)* - -**Type parameters:** - -#### T : `[]` -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> | - -**Returns:** `Observable`<`T`> - -___ - - -## referendumCount - -▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* - -*Defined in [Queries.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L79)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## referendumInfo - -▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* - -*Defined in [Queries.ts:83](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L83)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -___ - - -## referendumVote - -▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* - -*Defined in [Queries.ts:96](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L96)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Bool` | `undefined`> - -___ - - -## referendumVoters - -▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* - -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L100)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## referendumVotes - -▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> - -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L79)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<`boolean`> - -___ - - -## referendums - -▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L58)* - -**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -___ - - -## referendumsInfo - -▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumIds | `Array`< `ReferendumIndex` | `BN` | `number`> | - -**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -___ - - -## sessionBlockProgress - -▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L166)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionBlockRemaining - -▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L185)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionBrokenValue - -▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L200)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionCurrentIndex - -▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* - -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L148)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionCurrentStart - -▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* - -*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L152)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionLastLengthChange - -▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* - -*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L156)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionLength - -▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* - -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L160)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionReward - -▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* - -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L140)* - -**Returns:** `Observable`< `Perbill` | `undefined`> - -___ - - -## sessionRewardCurrent - -▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* - -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L144)* - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## sessionTimeExpected - -▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L219)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionTimeRemaining - -▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L234)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionValidators - -▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* - -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L168)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionsPerEra - -▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* - -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L164)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## stakingIntentions - -▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* - -*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L179)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## stakingNominating - -▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* - -*Defined in [Queries.ts:201](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L201)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `AccountId` | `undefined`> - -___ - - -## stakingNominatorsFor - -▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* - -*Defined in [Queries.ts:190](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L190)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## submitExtrinsic - -▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* - -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| extrinsic | `Extrinsic` | - -**Returns:** `Observable`< `Hash` | `undefined`> - -___ - - -## systemName - -▸ **systemName**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* - -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L39)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## systemVersion - -▸ **systemVersion**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* - -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L43)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## validatingBalance - -▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L249)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -___ - - -## validatingBalances - -▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)> - -*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L274)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)> - -___ - - -## validatorCount - -▸ **validatorCount**(): `Observable`< `u32` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* - -*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L205)* - -**Returns:** `Observable`< `u32` | `undefined`> - -___ - - -## votingBalance - -▸ **votingBalance**(_address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L288)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| _address | `AccountId` | `string`| - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -___ - - -## votingBalances - -▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]> - -*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L322)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]> - -___ - - -## votingBalancesNominatorsFor - -▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> - -*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L311)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`any`> - -___ - diff --git a/docs/api-observable/classes/_index_.api.md b/docs/api-observable/classes/_index_.api.md deleted file mode 100644 index a07a71aa00cb..000000000000 --- a/docs/api-observable/classes/_index_.api.md +++ /dev/null @@ -1,1055 +0,0 @@ - - -# Hierarchy - -↳ [ApiCombined](_combined_.apicombined.md) - -**↳ Api** - -# Constructors - - - -## constructor - -⊕ **new Api**(api: *`RxApiInterface`*): [Api](_index_.api.md) - -*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| api | `RxApiInterface` | - -**Returns:** [Api](_index_.api.md) - -___ - -# Properties - - - -## `` _api - -**● _api**: *`RxApiInterface`* - -*Inherited from [ApiBase](_base_.apibase.md).[_api](_base_.apibase.md#_api)* - -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L28)* - -___ - - -## `` _genesisHash - -**● _genesisHash**: *`Hash`* - -*Inherited from [ApiBase](_base_.apibase.md).[_genesisHash](_base_.apibase.md#_genesishash)* - -*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L29)* - -___ - - -## whenReady - -**● whenReady**: *`Observable`<`boolean`>* - -*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -___ - - -## `` extrinsics - -**● extrinsics**: *`Extrinsics`* = extrinsicsStatic - -*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* - -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L40)* - -___ - - -## `` storage - -**● storage**: *`Storage`* = storageStatic - -*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* - -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L41)* - -___ - -# Accessors - - - -## genesisHash - -getgenesisHash(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L78)* - -**Returns:** `Hash` - -___ - -# Methods - - - -## accountNonce - -▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* - -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Index` | `undefined`> - -___ - - -## balanceFree - -▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* - -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L23)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## balanceReserved - -▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* - -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## bestNumber - -▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* - -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L13)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## blockNow - -▸ **blockNow**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* - -*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L35)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## blockPeriod - -▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* - -*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L31)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## chain - -▸ **chain**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* - -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L25)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## `` combine - -▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* - -*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L71)* - -**Type parameters:** - -#### T -#### R -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| observables | `Array`<`Observable`<`any`>> | - | -| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn | - -**Returns:** `Observable`<`T`> - -___ - - -## democracyLaunchPeriod - -▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* - -*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L39)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## democracyNextTally - -▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* - -*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L43)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## democracyReferendumVoters - -▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)* - -*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>> - -___ - - -## democracyVotersBalancesOf - -▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)* - -*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`Balance`>> - -___ - - -## democracyVotersVotesOf - -▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)* - -*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L103)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`Bool`>> - -___ - - -## democracyVotingPeriod - -▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* - -*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L111)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockLength - -▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)* - -*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L114)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockProgress - -▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)* - -*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L129)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraBlockRemaining - -▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)* - -*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L151)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraLastLengthChange - -▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* - -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L136)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## fees - -▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* - -*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L115)* - -**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -___ - - -## getBlock - -▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* - -*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| hash | `Uint8Array` | - -**Returns:** `Observable`< `SignedBlock` | `undefined`> - -___ - - -## isConnected - -▸ **isConnected**(): `Observable`<`boolean`> - -*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* - -*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L82)* - -**Returns:** `Observable`<`boolean`> - -___ - - -## newHead - -▸ **newHead**(): `Observable`< `Header` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[newHead](_calls_.apicalls.md#newhead)* - -*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L33)* - -**Returns:** `Observable`< `Header` | `undefined`> - -___ - - -## proposalDeposits - -▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* - -*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| proposalId | `PropIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -___ - - -## publicProposalCount - -▸ **publicProposalCount**(): `Observable`<`number`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)* - -*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L20)* - -**Returns:** `Observable`<`number`> - -___ - - -## publicProposals - -▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* - -*Defined in [Queries.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L60)* - -**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -___ - - -## rawCall - -▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* - -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L86)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`T`> - -___ - - -## rawStorage - -▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* - -*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L98)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| key | `StorageFunction` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`< `T` | `undefined`> - -___ - - -## rawStorageMulti - -▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* - -*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L110)* - -**Type parameters:** - -#### T : `[]` -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> | - -**Returns:** `Observable`<`T`> - -___ - - -## referendumCount - -▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* - -*Defined in [Queries.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L79)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## referendumInfo - -▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* - -*Defined in [Queries.ts:83](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L83)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -___ - - -## referendumVote - -▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* - -*Defined in [Queries.ts:96](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L96)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Bool` | `undefined`> - -___ - - -## referendumVoters - -▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* - -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L100)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## referendumVotes - -▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)* - -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L79)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<`boolean`> - -___ - - -## referendums - -▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)* - -*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L58)* - -**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -___ - - -## referendumsInfo - -▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)* - -*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumIds | `Array`< `ReferendumIndex` | `BN` | `number`> | - -**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>> - -___ - - -## sessionBlockProgress - -▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)* - -*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L166)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionBlockRemaining - -▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)* - -*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L185)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionBrokenValue - -▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)* - -*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L200)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionCurrentIndex - -▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* - -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L148)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionCurrentStart - -▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* - -*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L152)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionLastLengthChange - -▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* - -*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L156)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionLength - -▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* - -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L160)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionReward - -▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* - -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L140)* - -**Returns:** `Observable`< `Perbill` | `undefined`> - -___ - - -## sessionRewardCurrent - -▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* - -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L144)* - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## sessionTimeExpected - -▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)* - -*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L219)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionTimeRemaining - -▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)* - -*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L234)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionValidators - -▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* - -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L168)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionsPerEra - -▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* - -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L164)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## stakingIntentions - -▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* - -*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L179)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## stakingNominating - -▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* - -*Defined in [Queries.ts:201](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L201)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `AccountId` | `undefined`> - -___ - - -## stakingNominatorsFor - -▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* - -*Defined in [Queries.ts:190](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L190)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## submitExtrinsic - -▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* - -*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| extrinsic | `Extrinsic` | - -**Returns:** `Observable`< `Hash` | `undefined`> - -___ - - -## systemName - -▸ **systemName**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* - -*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L39)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## systemVersion - -▸ **systemVersion**(): `Observable`< `Text` | `undefined`> - -*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* - -*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Calls.ts#L43)* - -**Returns:** `Observable`< `Text` | `undefined`> - -___ - - -## validatingBalance - -▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)* - -*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L249)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -___ - - -## validatingBalances - -▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)* - -*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L274)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)> - -___ - - -## validatorCount - -▸ **validatorCount**(): `Observable`< `u32` | `undefined`> - -*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* - -*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L205)* - -**Returns:** `Observable`< `u32` | `undefined`> - -___ - - -## votingBalance - -▸ **votingBalance**(_address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)* - -*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L288)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| _address | `AccountId` | `string`| - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)> - -___ - - -## votingBalances - -▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)* - -*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L322)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` addresses | `Array`< `AccountId` | `string`> | - -**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]> - -___ - - -## votingBalancesNominatorsFor - -▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> - -*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)* - -*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Combined.ts#L311)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`any`> - -___ - diff --git a/docs/api-observable/classes/_queries_.apiqueries.md b/docs/api-observable/classes/_queries_.apiqueries.md deleted file mode 100644 index fdb5d382e37f..000000000000 --- a/docs/api-observable/classes/_queries_.apiqueries.md +++ /dev/null @@ -1,577 +0,0 @@ - - -# Hierarchy - - [ApiBase](_base_.apibase.md) - -**↳ ApiQueries** - -↳ [ApiCalls](_calls_.apicalls.md) - -# Constructors - - - -## constructor - -⊕ **new ApiQueries**(api: *`RxApiInterface`*): [ApiQueries](_queries_.apiqueries.md) - -*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| api | `RxApiInterface` | - -**Returns:** [ApiQueries](_queries_.apiqueries.md) - -___ - -# Properties - - - -## `` _api - -**● _api**: *`RxApiInterface`* - -*Inherited from [ApiBase](_base_.apibase.md).[_api](_base_.apibase.md#_api)* - -*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L28)* - -___ - - -## `` _genesisHash - -**● _genesisHash**: *`Hash`* - -*Inherited from [ApiBase](_base_.apibase.md).[_genesisHash](_base_.apibase.md#_genesishash)* - -*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L29)* - -___ - - -## whenReady - -**● whenReady**: *`Observable`<`boolean`>* - -*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* - -*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L32)* - -___ - - -## `` extrinsics - -**● extrinsics**: *`Extrinsics`* = extrinsicsStatic - -*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* - -*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L40)* - -___ - - -## `` storage - -**● storage**: *`Storage`* = storageStatic - -*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* - -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L41)* - -___ - -# Accessors - - - -## genesisHash - -getgenesisHash(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L78)* - -**Returns:** `Hash` - -___ - -# Methods - - - -## accountNonce - -▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> - -*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Index` | `undefined`> - -___ - - -## balanceFree - -▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L23)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## balanceReserved - -▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> - -*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## blockNow - -▸ **blockNow**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L35)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## blockPeriod - -▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L31)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## `` combine - -▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)* - -*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L71)* - -**Type parameters:** - -#### T -#### R -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| observables | `Array`<`Observable`<`any`>> | - | -| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn | - -**Returns:** `Observable`<`T`> - -___ - - -## democracyLaunchPeriod - -▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L39)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## democracyNextTally - -▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L43)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## democracyVotingPeriod - -▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L111)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## eraLastLengthChange - -▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L136)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## fees - -▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L115)* - -**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)> - -___ - - -## isConnected - -▸ **isConnected**(): `Observable`<`boolean`> - -*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* - -*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L82)* - -**Returns:** `Observable`<`boolean`> - -___ - - -## proposalDeposits - -▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| proposalId | `PropIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> - -___ - - -## publicProposals - -▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -*Defined in [Queries.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L60)* - -**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> - -___ - - -## rawCall - -▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* - -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L86)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`T`> - -___ - - -## rawStorage - -▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* - -*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L98)* - -**Type parameters:** - -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| key | `StorageFunction` | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`< `T` | `undefined`> - -___ - - -## rawStorageMulti - -▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> - -*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* - -*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Base.ts#L110)* - -**Type parameters:** - -#### T : `[]` -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> | - -**Returns:** `Observable`<`T`> - -___ - - -## referendumCount - -▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> - -*Defined in [Queries.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L79)* - -**Returns:** `Observable`< `ReferendumIndex` | `undefined`> - -___ - - -## referendumInfo - -▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -*Defined in [Queries.ts:83](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L83)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| referendumId | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`> - -___ - - -## referendumVote - -▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> - -*Defined in [Queries.ts:96](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L96)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `Bool` | `undefined`> - -___ - - -## referendumVoters - -▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> - -*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L100)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `ReferendumIndex` | `BN` | `number`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionCurrentIndex - -▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L148)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionCurrentStart - -▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> - -*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L152)* - -**Returns:** `Observable`< `Moment` | `undefined`> - -___ - - -## sessionLastLengthChange - -▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L156)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionLength - -▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L160)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## sessionReward - -▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> - -*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L140)* - -**Returns:** `Observable`< `Perbill` | `undefined`> - -___ - - -## sessionRewardCurrent - -▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> - -*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L144)* - -**Returns:** `Observable`< `Balance` | `undefined`> - -___ - - -## sessionValidators - -▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> - -*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L168)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## sessionsPerEra - -▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> - -*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L164)* - -**Returns:** `Observable`< `BlockNumber` | `undefined`> - -___ - - -## stakingIntentions - -▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> - -*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L179)* - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## stakingNominating - -▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> - -*Defined in [Queries.ts:201](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L201)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`< `AccountId` | `undefined`> - -___ - - -## stakingNominatorsFor - -▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> - -*Defined in [Queries.ts:190](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L190)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| address | `AccountId` | `string`| - -**Returns:** `Observable`<`Array`<`AccountId`>> - -___ - - -## validatorCount - -▸ **validatorCount**(): `Observable`< `u32` | `undefined`> - -*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/Queries.ts#L205)* - -**Returns:** `Observable`< `u32` | `undefined`> - -___ - diff --git a/docs/api-observable/modules/_base_.md b/docs/api-observable/modules/_base_.md deleted file mode 100644 index 4e6114961b65..000000000000 --- a/docs/api-observable/modules/_base_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiBase](../classes/_base_.apibase.md) - ---- - diff --git a/docs/api-observable/modules/_calls_.md b/docs/api-observable/modules/_calls_.md deleted file mode 100644 index 7942fe1908ed..000000000000 --- a/docs/api-observable/modules/_calls_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiCalls](../classes/_calls_.apicalls.md) - ---- - diff --git a/docs/api-observable/modules/_classes_.md b/docs/api-observable/modules/_classes_.md deleted file mode 100644 index b82aeb77ee67..000000000000 --- a/docs/api-observable/modules/_classes_.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Index - -### Classes - -* [RxProposal](../classes/_classes_.rxproposal.md) -* [RxProposalDeposits](../classes/_classes_.rxproposaldeposits.md) -* [RxReferendum](../classes/_classes_.rxreferendum.md) - ---- - diff --git a/docs/api-observable/modules/_combined_.md b/docs/api-observable/modules/_combined_.md deleted file mode 100644 index cbd7d10ead1b..000000000000 --- a/docs/api-observable/modules/_combined_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiCombined](../classes/_combined_.apicombined.md) - ---- - diff --git a/docs/api-observable/modules/_index_.md b/docs/api-observable/modules/_index_.md deleted file mode 100644 index 7e08da80695e..000000000000 --- a/docs/api-observable/modules/_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Api](../classes/_index_.api.md) - ---- - diff --git a/docs/api-observable/modules/_queries_.md b/docs/api-observable/modules/_queries_.md deleted file mode 100644 index b9d69fbcfc31..000000000000 --- a/docs/api-observable/modules/_queries_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiQueries](../classes/_queries_.apiqueries.md) - ---- - diff --git a/docs/api-observable/modules/_types_d_.md b/docs/api-observable/modules/_types_d_.md deleted file mode 100644 index 29a99251466a..000000000000 --- a/docs/api-observable/modules/_types_d_.md +++ /dev/null @@ -1,61 +0,0 @@ - - -# Type aliases - - - -## ApiFunctions - -**Ƭ ApiFunctions**: * `keyof ApiBase` | `keyof ApiCalls` | `keyof ApiCombined` | `keyof ApiQueries` -* - -*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/types.d.ts#L14)* - -___ - - -## RxBalance - -**Ƭ RxBalance**: *`object`* - -*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/types.d.ts#L16)* - -#### Type declaration - -___ - - -## RxBalanceMap - -**Ƭ RxBalanceMap**: *`object`* - -*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/types.d.ts#L40)* - -#### Type declaration - -[index: `string`]: [RxBalance](_types_d_.md#rxbalance) - -___ - - -## RxFees - -**Ƭ RxFees**: *`object`* - -*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/types.d.ts#L26)* - -#### Type declaration - -___ - - -## RxReferendumVote - -**Ƭ RxReferendumVote**: *`object`* - -*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-observable/src/types.d.ts#L34)* - -#### Type declaration - -___ - diff --git a/docs/api-provider/README.md b/docs/api-provider/README.md deleted file mode 100644 index 3c876d13639f..000000000000 --- a/docs/api-provider/README.md +++ /dev/null @@ -1,28 +0,0 @@ - -[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-provider.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-provider) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider#info=devDependencies) - -@polkadot/api-provider -====================== - -Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces. - -Usage ------ - -Installation - - -``` -npm install --save @polkadot/api-provider -``` - -Initialisation - - -```js -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('http://127.0.0.1:9944'); -const version = await provider.send('client_version', []); - -console.log('clientVersion', version); -``` - diff --git a/docs/api-provider/SUMMARY.md b/docs/api-provider/SUMMARY.md deleted file mode 100644 index 2b24fb5fc5f7..000000000000 --- a/docs/api-provider/SUMMARY.md +++ /dev/null @@ -1,23 +0,0 @@ -* ["coder/json/decodeResponse"](modules/_coder_json_decoderesponse_.md) -* ["coder/json/encodeJson"](modules/_coder_json_encodejson_.md) -* ["coder/json/encodeObject"](modules/_coder_json_encodeobject_.md) -* ["coder/json/index"](modules/_coder_json_index_.md) -* ["coder/json/types.d"](modules/_coder_json_types_d_.md) -* ["http/index"](modules/_http_index_.md) - * [HttpProvider](classes/_http_index_.httpprovider.md) -* ["http/polyfill"](modules/_http_polyfill_.md) -* ["http/types.d"](modules/_http_types_d_.md) -* ["index"](modules/_index_.md) -* ["mock/index"](modules/_mock_index_.md) -* ["mock/mocks"](modules/_mock_mocks_.md) -* ["mock/on"](modules/_mock_on_.md) -* ["mock/send"](modules/_mock_send_.md) -* ["mock/state"](modules/_mock_state_.md) -* ["mock/subscribe"](modules/_mock_subscribe_.md) -* ["mock/types.d"](modules/_mock_types_d_.md) -* ["mock/unsubscribe"](modules/_mock_unsubscribe_.md) -* ["types.d"](modules/_types_d_.md) - * [ProviderInterface](interfaces/_types_d_.providerinterface.md) -* ["ws/index"](modules/_ws_index_.md) - * [WsProvider](classes/_ws_index_.wsprovider.md) -* ["ws/polyfill"](modules/_ws_polyfill_.md) diff --git a/docs/api-provider/classes/_http_index_.httpprovider.html b/docs/api-provider/classes/_http_index_.httpprovider.html deleted file mode 100644 index 7bf3fbb1daf2..000000000000 --- a/docs/api-provider/classes/_http_index_.httpprovider.html +++ /dev/null @@ -1,623 +0,0 @@ - - - - - - - HttpProvider · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - - - - - - -
- -
- -
- - - - - - - - -
-
- -
-
- -
- -

name: HttpProvider

-

summary: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.

-

description: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the WsProvider.

-

example:

-
import Api from '@polkadot/api';
-import HttpProvider from '@polkadot/api-provider/http';
-
-const provider = new HttpProvider('http://127.0.0.1:9933');
-const api = new Api(provider);
-
-

see: WsProvider

-

Hierarchy

-

HttpProvider

-

Implements

- -

Constructors

-

-

constructor

-

⊕ new HttpProvider(endpoint: string): HttpProvider

-

Defined in http/index.ts:40

-

Parameters:

- - - - - - - - - - - - - - - -
ParamTypeDescription
endpointstringThe endpoint url starting with http://
-

Returns: HttpProvider

-
-

Methods

-

-

isConnected

-

▸ isConnected(): boolean

-

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:57

-

summary: Whether the node is connected or not.

-

Returns: boolean -true if connected

-
-

-

on

-

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

-

Implementation of ProviderInterface.on

-

Defined in http/index.ts:65

-

summary: Events are not supported with the HttpProvider, see WsProvider.

-

description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

-

Parameters:

- - - - - - - - - - - - - - - - - -
ParamType
typeProviderInterface$Emitted
subProviderInterface$EmitCb
-

Returns: void

-
-

-

send

-

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

-

Implementation of ProviderInterface.send

-

Defined in http/index.ts:72

-

summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

-

Parameters:

- - - - - - - - - - - - - - - - - -
ParamType
methodstring
paramsArray<any>
-

Returns: Promise<any>

-
-

-

subscribe

-

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

-

Implementation of ProviderInterface.subscribe

-

Defined in http/index.ts:94

-

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
typesstring
methodstring
paramsArray<any>
cbProviderInterface$Callback
-

Returns: Promise<number>

-
-

-

unsubscribe

-

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

-

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:103

-

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
ParamType
typestring
methodstring
idnumber
-

Returns: Promise<boolean>

-
- - -
- -
-
-
- -

results matching ""

-
    - -
    -
    - -

    No results matching ""

    - -
    -
    -
    - -
    -
    - -
    - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-provider/classes/_http_index_.httpprovider.md b/docs/api-provider/classes/_http_index_.httpprovider.md deleted file mode 100644 index 81551260d388..000000000000 --- a/docs/api-provider/classes/_http_index_.httpprovider.md +++ /dev/null @@ -1,159 +0,0 @@ - - -*__name__*: HttpProvider - -*__summary__*: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port. - -*__description__*: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the [WsProvider](_ws_index_.wsprovider.md). - -*__example__*: -```javascript -import Api from '@polkadot/api'; -import HttpProvider from '@polkadot/api-provider/http'; - -const provider = new HttpProvider('http://127.0.0.1:9933'); -const api = new Api(provider); -``` - -*__see__*: [WsProvider](_ws_index_.wsprovider.md) - -# Hierarchy - -**HttpProvider** - -# Implements - -* [ProviderInterface](../interfaces/_types_d_.providerinterface.md) - -# Constructors - - - -## constructor - -⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md) - -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L40)* - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| endpoint | `string` | The endpoint url starting with http:// | - -**Returns:** [HttpProvider](_http_index_.httpprovider.md) - -___ - -# Methods - - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)* - -*Defined in [http/index.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L57)* - -*__summary__*: Whether the node is connected or not. - -**Returns:** `boolean` -true if connected - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)* - -*Defined in [http/index.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L65)* - -*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -*__description__*: HTTP Provider does not have 'on' emitters. WebSockets should be used instead. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)* - -*Defined in [http/index.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L72)* - -*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)* - -*Defined in [http/index.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L94)* - -*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| types | `string` | -| method | `string` | -| params | `Array`<`any`> | -| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | - -**Returns:** `Promise`<`number`> - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)* - -*Defined in [http/index.ts:103](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/index.ts#L103)* - -*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.html b/docs/api-provider/classes/_ws_index_.wsprovider.html deleted file mode 100644 index ee4434365185..000000000000 --- a/docs/api-provider/classes/_ws_index_.wsprovider.html +++ /dev/null @@ -1,904 +0,0 @@ - - - - - - - WsProvider · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - - - - - - -
    - -
    - -
    - - - - - - - - -
    -
    - -
    -
    - -
    - -

    name: WsProvider

    -

    summary: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.

    -

    description: 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';
-import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
    -

    see: HttpProvider

    -

    Type parameters

    -

    EventTypes : string | symbol

    -

    Hierarchy

    -

    EventEmitter

    -

    ↳ WsProvider

    -

    Implements

    -
      -
    • WSProviderInterface
      • -
    -

    Constructors

    -

    -

    constructor

    -

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

    -

    Defined in ws/index.ts:73

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - - - -
    ParamTypeDefault valueDescription
    endpointstring-The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`
    Default value autoConnectbooleantrueWhether to connect automatically or not.
    -

    Returns: WsProvider

    -
    -

    Properties

    -

    -

    <Static> prefixed

    -

    ● prefixed: string | boolean -

    -

    Inherited from EventEmitter.prefixed

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6

    -
    -

    Methods

    -

    -

    addListener

    -

    ▸ addListener(event: EventTypes, fn: ListenerFn, context?: any): this

    -

    Inherited from EventEmitter.addListener

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    fnListenerFn
    Optional contextany
    -

    Returns: this

    -
    -

    -

    connect

    -

    ▸ connect(): void

    -

    Defined in ws/index.ts:104

    -

    summary: Manually connect

    -

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

    -

    Returns: void

    -
    -

    -

    emit

    -

    ▸ emit(event: EventTypes, ...args: Array<any>): boolean

    -

    Inherited from EventEmitter.emit

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27

    -

    Calls each of the listeners registered for a given event.

    -

    Parameters:

    - - - - - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    Rest argsArray<any>
    -

    Returns: boolean

    -
    -

    -

    eventNames

    -

    ▸ eventNames(): Array<EventTypes>

    -

    Inherited from EventEmitter.eventNames

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12

    -

    Return an array listing the events for which the emitter has registered listeners.

    -

    Returns: Array<EventTypes>

    -
    -

    -

    isConnected

    -

    ▸ isConnected(): boolean

    -

    Defined in ws/index.ts:121

    -

    summary: Whether the node is connected or not.

    -

    Returns: boolean -true if connected

    -
    -

    -

    listenerCount

    -

    ▸ listenerCount(event: EventTypes): number

    -

    Inherited from EventEmitter.listenerCount

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22

    -

    Return the number of listeners listening to a given event.

    -

    Parameters:

    - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    -

    Returns: number

    -
    -

    -

    listeners

    -

    ▸ listeners(event: EventTypes): Array<ListenerFn>

    -

    Inherited from EventEmitter.listeners

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17

    -

    Return the listeners registered for a given event.

    -

    Parameters:

    - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    -

    Returns: Array<ListenerFn>

    -
    -

    -

    off

    -

    ▸ off(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

    -

    Inherited from EventEmitter.off

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    Optional fnListenerFn
    Optional contextany
    Optional onceundefined | false | true
    -

    Returns: this

    -
    -

    -

    on

    -

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

    -

    Overrides EventEmitter.on

    -

    Defined in ws/index.ts:131

    -

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

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - -
    ParamTypeDescription
    typeProviderInterface$EmittedEvent
    subProviderInterface$EmitCbCallback
    -

    Returns: this -[description]

    -
    -

    -

    once

    -

    ▸ once(event: EventTypes, fn: ListenerFn, context?: any): this

    -

    Inherited from EventEmitter.once

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38

    -

    Add a one-time listener for a given event.

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    fnListenerFn
    Optional contextany
    -

    Returns: this

    -
    -

    -

    removeAllListeners

    -

    ▸ removeAllListeners(event?: EventTypes): this

    -

    Inherited from EventEmitter.removeAllListeners

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49

    -

    Remove all listeners, or those of the specified event.

    -

    Parameters:

    - - - - - - - - - - - - - -
    ParamType
    Optional eventEventTypes
    -

    Returns: this

    -
    -

    -

    removeListener

    -

    ▸ removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

    -

    Inherited from EventEmitter.removeListener

    -

    Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43

    -

    Remove the listeners of a given event.

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    eventEventTypes
    Optional fnListenerFn
    Optional contextany
    Optional onceundefined | false | true
    -

    Returns: this

    -
    -

    -

    send

    -

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

    -

    Defined in ws/index.ts:138

    -

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

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    methodstring
    paramsArray<any>
    Optional subscriptionSubscriptionHandler
    -

    Returns: Promise<any>

    -
    -

    -

    subscribe

    -

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

    -

    Defined in ws/index.ts:194

    -

    name: subscribe

    -

    summary: Allows subscribing to a specific event.

    -

    example:

    -
    const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
-api.state.storage([[storage.balances.freeBalance, <Address>]], (_, values) => {
-  console.log(values)
-}).then((subscriptionId) => {
-  console.log('balance changes subscription id: ', subscriptionId)
-})
-
    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParamTypeDescription
    typestringSubscription type
    methodstringSubscription method
    paramsArray<any>Parameters
    callbackProviderInterface$CallbackCallback
    -

    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/index.ts:203

    -

    summary: Allows unsubscribing to subscriptions made with subscribe.

    -

    Parameters:

    - - - - - - - - - - - - - - - - - - - - - -
    ParamType
    typestring
    methodstring
    idnumber
    -

    Returns: Promise<boolean>

    -
    - - -
    - -
    -
    -
    - -

    results matching ""

    -
      - -
      -
      - -

      No results matching ""

      - -
      -
      -
      - -
      -
      - -
      - - - - - - - - - - - - - - -
      - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.md b/docs/api-provider/classes/_ws_index_.wsprovider.md deleted file mode 100644 index bbae4e257e00..000000000000 --- a/docs/api-provider/classes/_ws_index_.wsprovider.md +++ /dev/null @@ -1,392 +0,0 @@ - - -*__name__*: WsProvider - -*__summary__*: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. - -*__description__*: Unlike the [HttpProvider](_http_index_.httpprovider.md), it does support subscriptions and allows listening to events such as new blocks or balance changes. - -*__example__*: -```javascript -import Api from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); -``` - -*__see__*: [HttpProvider](_http_index_.httpprovider.md) - -# Type parameters -#### EventTypes : `string` | `symbol` - -# Hierarchy - - `EventEmitter` - -**↳ WsProvider** - -# Implements - -* `WSProviderInterface` - -# Constructors - - - -## constructor - -⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) - -*Defined in [ws/index.ts:73](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L73)* - -**Parameters:** - -| Param | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| endpoint | `string` | - | 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_index_.wsprovider.md) - -___ - -# Properties - - - -## `` prefixed - -**● prefixed**: * `string` | `boolean` -* - -*Inherited from EventEmitter.prefixed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6* - -___ - -# Methods - - - -## addListener - -▸ **addListener**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` - -*Inherited from EventEmitter.addListener* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| fn | `ListenerFn` | -| `Optional` context | `any` | - -**Returns:** `this` - -___ - - -## connect - -▸ **connect**(): `void` - -*Defined in [ws/index.ts:104](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L104)* - -*__summary__*: Manually connect - -*__description__*: The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default, however if you decided otherwise, you may connect manually using this method. - -**Returns:** `void` - -___ - - -## emit - -▸ **emit**(event: *`EventTypes`*, ...args: *`Array`<`any`>*): `boolean` - -*Inherited from EventEmitter.emit* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27* - -Calls each of the listeners registered for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Rest` args | `Array`<`any`> | - -**Returns:** `boolean` - -___ - - -## eventNames - -▸ **eventNames**(): `Array`<`EventTypes`> - -*Inherited from EventEmitter.eventNames* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12* - -Return an array listing the events for which the emitter has registered listeners. - -**Returns:** `Array`<`EventTypes`> - -___ - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [ws/index.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L121)* - -*__summary__*: Whether the node is connected or not. - -**Returns:** `boolean` -true if connected - -___ - - -## listenerCount - -▸ **listenerCount**(event: *`EventTypes`*): `number` - -*Inherited from EventEmitter.listenerCount* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22* - -Return the number of listeners listening to a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | - -**Returns:** `number` - -___ - - -## listeners - -▸ **listeners**(event: *`EventTypes`*): `Array`<`ListenerFn`> - -*Inherited from EventEmitter.listeners* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17* - -Return the listeners registered for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | - -**Returns:** `Array`<`ListenerFn`> - -___ - - -## off - -▸ **off**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` - -*Inherited from EventEmitter.off* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | -| `Optional` context | `any` | -| `Optional` once | `undefined` | `false` | `true`| - -**Returns:** `this` - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `this` - -*Overrides EventEmitter.on* - -*Defined in [ws/index.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L131)* - -*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | Event | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | Callback | - -**Returns:** `this` -[description] - -___ - - -## once - -▸ **once**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` - -*Inherited from EventEmitter.once* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38* - -Add a one-time listener for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| fn | `ListenerFn` | -| `Optional` context | `any` | - -**Returns:** `this` - -___ - - -## removeAllListeners - -▸ **removeAllListeners**(event?: *[EventTypes]()*): `this` - -*Inherited from EventEmitter.removeAllListeners* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49* - -Remove all listeners, or those of the specified event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` event | [EventTypes]() | - -**Returns:** `this` - -___ - - -## removeListener - -▸ **removeListener**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` - -*Inherited from EventEmitter.removeListener* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43* - -Remove the listeners of a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | -| `Optional` context | `any` | -| `Optional` once | `undefined` | `false` | `true`| - -**Returns:** `this` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> - -*Defined in [ws/index.ts:138](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L138)* - -*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | -| `Optional` subscription | `SubscriptionHandler` | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [ws/index.ts:194](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L194)* - -*__name__*: subscribe - -*__summary__*: Allows subscribing to a specific event. - -*__example__*: -```javascript -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); - -api.state.storage([[storage.balances.freeBalance,
      ]], (_, values) => { - console.log(values) -}).then((subscriptionId) => { - console.log('balance changes subscription id: ', subscriptionId) -}) -``` - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| type | `string` | Subscription type | -| method | `string` | Subscription method | -| params | `Array`<`any`> | Parameters | -| callback | [ProviderInterface$Callback](../modules/_types_d_.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/index.ts:203](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/ws/index.ts#L203)* - -*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/api-provider/index.html b/docs/api-provider/index.html deleted file mode 100644 index 69564b5c4362..000000000000 --- a/docs/api-provider/index.html +++ /dev/null @@ -1,465 +0,0 @@ - - - - - - - api-provider · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      -
      - - - - - - - - -
      - -
      - -
      - - - - - - - - -
      -
      - -
      -
      - -
      - -

      polkadotjs isc style npm travis maintainability coverage dependency devDependency

      -

      @polkadot/api-provider

      -

      Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces.

      -

      Usage

      -

      Installation -

      -
      npm install --save @polkadot/api-provider
-

      Initialisation -

      -
      import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('http://127.0.0.1:9944');
-const version = await provider.send('client_version', []);
-
-console.log('clientVersion', version);
-
      - - -
      - -
      -
      -
      - -

      results matching ""

      -
        - -
        -
        - -

        No results matching ""

        - -
        -
        -
        - -
        -
        - -
        - - - - - - - - - - - - - - -
        - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-provider/interfaces/_types_d_.providerinterface.md b/docs/api-provider/interfaces/_types_d_.providerinterface.md deleted file mode 100644 index e5233d8f5de4..000000000000 --- a/docs/api-provider/interfaces/_types_d_.providerinterface.md +++ /dev/null @@ -1,99 +0,0 @@ - - -# Hierarchy - -**ProviderInterface** - -# Implemented by - -* [HttpProvider](../classes/_http_index_.httpprovider.md) - -# Methods - - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L45)* - -**Returns:** `boolean` - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` - -*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L46)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| params | `Array`<`any`> | -| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | - -**Returns:** `Promise`<`number`> - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L49)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md deleted file mode 100644 index 0f983486747f..000000000000 --- a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Hierarchy - -**EventEmitterStatic** - -# Constructors - - - -## constructor - -⊕ **new EventEmitterStatic**<`EventTypes`>(): `EventEmitter`<`EventTypes`> - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:57* - -**Type parameters:** - -#### EventTypes : `string` | `symbol` - -**Returns:** `EventEmitter`<`EventTypes`> - -___ - diff --git a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md deleted file mode 100644 index a621570ab61d..000000000000 --- a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Hierarchy - -**ListenerFn** - -# Callable -▸ **__call**(...args: *`Array`<`any`>*): `void` - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:53* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` args | `Array`<`any`> | - -**Returns:** `void` - diff --git a/docs/api-provider/modules/_coder_json_decoderesponse_.md b/docs/api-provider/modules/_coder_json_decoderesponse_.md deleted file mode 100644 index b2131500b163..000000000000 --- a/docs/api-provider/modules/_coder_json_decoderesponse_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Functions - - - -## decodeResponse - -▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any` - -*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/decodeResponse.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| response | [JsonRpcResponse](_types_d_.md#jsonrpcresponse) | - -**Returns:** `any` - -___ - diff --git a/docs/api-provider/modules/_coder_json_encodejson_.md b/docs/api-provider/modules/_coder_json_encodejson_.md deleted file mode 100644 index a66110f393c2..000000000000 --- a/docs/api-provider/modules/_coder_json_encodejson_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## encodeJson - -▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string` - -*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/encodeJson.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `string` - -___ - diff --git a/docs/api-provider/modules/_coder_json_encodeobject_.md b/docs/api-provider/modules/_coder_json_encodeobject_.md deleted file mode 100644 index eccb70761715..000000000000 --- a/docs/api-provider/modules/_coder_json_encodeobject_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## encodeObject - -▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest) - -*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/encodeObject.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** [JsonRpcRequest](_types_d_.md#jsonrpcrequest) - -___ - diff --git a/docs/api-provider/modules/_coder_json_index_.md b/docs/api-provider/modules/_coder_json_index_.md deleted file mode 100644 index 2c83d754a381..000000000000 --- a/docs/api-provider/modules/_coder_json_index_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Functions - - - -## rpcCoder - -▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder) - -*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/index.ts#L12)* - -**Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder) - -___ - diff --git a/docs/api-provider/modules/_coder_json_types_d_.md b/docs/api-provider/modules/_coder_json_types_d_.md deleted file mode 100644 index 26531a06ea3a..000000000000 --- a/docs/api-provider/modules/_coder_json_types_d_.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Type aliases - - - -## RpcCoder - -**Ƭ RpcCoder**: *`object`* - -*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/types.d.ts#L7)* - -#### Type declaration - -___ - - -## RpcCoderState - -**Ƭ RpcCoderState**: *`object`* - -*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/coder/json/types.d.ts#L14)* - -#### Type declaration - -___ - diff --git a/docs/api-provider/modules/_http_index_.md b/docs/api-provider/modules/_http_index_.md deleted file mode 100644 index b670dfa25b70..000000000000 --- a/docs/api-provider/modules/_http_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [HttpProvider](../classes/_http_index_.httpprovider.md) - ---- - diff --git a/docs/api-provider/modules/_http_polyfill_.md b/docs/api-provider/modules/_http_polyfill_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/api-provider/modules/_http_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/api-provider/modules/_http_types_d_.md b/docs/api-provider/modules/_http_types_d_.md deleted file mode 100644 index 446635998f35..000000000000 --- a/docs/api-provider/modules/_http_types_d_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Type aliases - - - -## HttpState - -**Ƭ HttpState**: *`object`* - -*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/http/types.d.ts#L8)* - -#### Type declaration - -___ - diff --git a/docs/api-provider/modules/_index_.md b/docs/api-provider/modules/_index_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/api-provider/modules/_index_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/api-provider/modules/_mock_index_.md b/docs/api-provider/modules/_mock_index_.md deleted file mode 100644 index 7d554967969a..000000000000 --- a/docs/api-provider/modules/_mock_index_.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Functions - - - -## mockProvider - -▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md) - -*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/index.ts#L18)* - -A moock provider mainly used for testing. - -**Returns:** [ProviderInterface](../interfaces/_types_d_.providerinterface.md) -The mock provider - -___ - diff --git a/docs/api-provider/modules/_mock_mocks_.md b/docs/api-provider/modules/_mock_mocks_.md deleted file mode 100644 index 7b845825329d..000000000000 --- a/docs/api-provider/modules/_mock_mocks_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## mocks - -▸ **mocks**(__namedParameters: *`object`*): `void` - -*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/mocks.ts#L63)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | - -**Returns:** `void` - -___ - diff --git a/docs/api-provider/modules/_mock_on_.md b/docs/api-provider/modules/_mock_on_.md deleted file mode 100644 index a56d7d15a3bf..000000000000 --- a/docs/api-provider/modules/_mock_on_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## on - -▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void` - -*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/on.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | [ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - diff --git a/docs/api-provider/modules/_mock_send_.md b/docs/api-provider/modules/_mock_send_.md deleted file mode 100644 index 7152e5e4be02..000000000000 --- a/docs/api-provider/modules/_mock_send_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## send - -▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/send.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - diff --git a/docs/api-provider/modules/_mock_state_.md b/docs/api-provider/modules/_mock_state_.md deleted file mode 100644 index 81a4d6c52bbd..000000000000 --- a/docs/api-provider/modules/_mock_state_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Functions - - - -## state - -▸ **state**(): [MockState](_mock_types_d_.md#mockstate) - -*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/state.ts#L38)* - -**Returns:** [MockState](_mock_types_d_.md#mockstate) - -___ - diff --git a/docs/api-provider/modules/_mock_subscribe_.md b/docs/api-provider/modules/_mock_subscribe_.md deleted file mode 100644 index 481a78e0f8b5..000000000000 --- a/docs/api-provider/modules/_mock_subscribe_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## subscribe - -▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`> - -*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/subscribe.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | `string` | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`number`> - -___ - diff --git a/docs/api-provider/modules/_mock_types_d_.md b/docs/api-provider/modules/_mock_types_d_.md deleted file mode 100644 index 01cd2721c505..000000000000 --- a/docs/api-provider/modules/_mock_types_d_.md +++ /dev/null @@ -1,87 +0,0 @@ - - -# Type aliases - - - -## MockState - -**Ƭ MockState**: *`object`* - -*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/types.d.ts#L27)* - -#### Type declaration - -___ - - -## MockState$Db - -**Ƭ MockState$Db**: *`object`* - -*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/types.d.ts#L19)* - -#### Type declaration - -[index: `string`]: `Uint8Array` - -___ - - -## MockState$Requests - -**Ƭ MockState$Requests**: *`object`* - -*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/types.d.ts#L23)* - -#### Type declaration - -[index: `string`]: `function` - -▸(db: *[MockState$Db](_mock_types_d_.md#mockstate_db)*, params: *`Array`<`any`>*): `string` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| db | [MockState$Db](_mock_types_d_.md#mockstate_db) | -| params | `Array`<`any`> | - -**Returns:** `string` - -___ - - -## MockState$Subscription$Callback - -**Ƭ MockState$Subscription$Callback**: *`function`* - -*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/types.d.ts#L8)* - -#### Type declaration -▸(error: * `Error` | `null`*, value: *`any`*): `void` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| error | `Error` | `null`| -| value | `any` | - -**Returns:** `void` - -___ - - -## MockState$Subscriptions - -**Ƭ MockState$Subscriptions**: *`object`* - -*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/types.d.ts#L10)* - -#### Type declaration - -[index: `string`]: `object` - -___ - diff --git a/docs/api-provider/modules/_mock_unsubscribe_.md b/docs/api-provider/modules/_mock_unsubscribe_.md deleted file mode 100644 index be9cbdbc2f91..000000000000 --- a/docs/api-provider/modules/_mock_unsubscribe_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## unsubscribe - -▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/mock/unsubscribe.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | `string` | -| name | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/api-provider/modules/_types_d_.md b/docs/api-provider/modules/_types_d_.md deleted file mode 100644 index c767a3adb8bb..000000000000 --- a/docs/api-provider/modules/_types_d_.md +++ /dev/null @@ -1,108 +0,0 @@ - - -# Type aliases - - - -## JsonRpcObject - -**Ƭ JsonRpcObject**: *`object`* - -*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L5)* - -#### Type declaration - -___ - - -## JsonRpcRequest - -**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object` -* - -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L10)* - -___ - - -## JsonRpcResponse - -**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase) -* - -*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L36)* - -___ - - -## JsonRpcResponseBase - -**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription` -* - -*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L34)* - -___ - - -## JsonRpcResponseBase$Error - -**Ƭ JsonRpcResponseBase$Error**: *`object`* - -*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L15)* - -#### Type declaration - -___ - - -## ProviderInterface$Callback - -**Ƭ ProviderInterface$Callback**: *`function`* - -*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L38)* - -#### Type declaration -▸(error: * `Error` | `null`*, result: *`any`*): `void` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| error | `Error` | `null`| -| result | `any` | - -**Returns:** `void` - -___ - - -## ProviderInterface$EmitCb - -**Ƭ ProviderInterface$EmitCb**: *`function`* - -*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L42)* - -#### Type declaration -▸(value?: *`any`*): `any` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** `any` - -___ - - -## ProviderInterface$Emitted - -**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" -* - -*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-provider/src/types.d.ts#L40)* - -___ - diff --git a/docs/api-provider/modules/_ws_index_.md b/docs/api-provider/modules/_ws_index_.md deleted file mode 100644 index 5849e288b407..000000000000 --- a/docs/api-provider/modules/_ws_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [WsProvider](../classes/_ws_index_.wsprovider.md) - ---- - diff --git a/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md b/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md deleted file mode 100644 index 18004cecc23c..000000000000 --- a/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Index - -### Interfaces - -* [EventEmitterStatic](../interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md) -* [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) - -### Variables - -* [EventEmitter](_ws_index_.wsprovider.eventemitter.md#eventemitter) - ---- - -# Variables - - - -## `` EventEmitter - -**● EventEmitter**: *`EventEmitterStatic`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61* - -___ - diff --git a/docs/api-provider/modules/_ws_polyfill_.md b/docs/api-provider/modules/_ws_polyfill_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/api-provider/modules/_ws_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/api-rx/README.md b/docs/api-rx/README.md deleted file mode 100644 index 0a560dd8d1f5..000000000000 --- a/docs/api-rx/README.md +++ /dev/null @@ -1,8 +0,0 @@ - -[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-rx.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-rx) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx#info=devDependencies) - -@polkadot/api-rx -================ - -An RxJs wrapper around the [@polkadot/api](../api). - diff --git a/docs/api-rx/SUMMARY.md b/docs/api-rx/SUMMARY.md deleted file mode 100644 index 4194bf89d2a5..000000000000 --- a/docs/api-rx/SUMMARY.md +++ /dev/null @@ -1,4 +0,0 @@ -* ["defaults"](modules/_defaults_.md) -* ["index"](modules/_index_.md) - * [RxApi](classes/_index_.rxapi.md) -* ["types.d"](modules/_types_d_.md) diff --git a/docs/api-rx/classes/_index_.rxapi.html b/docs/api-rx/classes/_index_.rxapi.html deleted file mode 100644 index 33d573133f29..000000000000 --- a/docs/api-rx/classes/_index_.rxapi.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - ApiRx · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        -
        - - - - - - - - -
        - -
        - -
        - - - - - - - - -
        -
        - -
        -
        - -
        - -

        name: RxApi

        -

        summary: The RxJS API is a wrapper around the API.

        -

        description: It allows wrapping API components with observables using RxJS.

        -

        example:

        -
        import RxApi from '@polkadot/api';
-import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('http://127.0.0.1:9944');
-const rxapi = new RxApi(provider);
-
        -

        Hierarchy

        -

        RxApi

        -

        Implements

        -
          -
        • object
          • -
        -

        Constructors

        -

        -

        constructor

        -

        ⊕ new RxApi(provider?: ProviderInterface): RxApi

        -

        Defined in index.ts:46

        -

        Parameters:

        - - - - - - - - - - - - - - - - - -
        ParamTypeDefault valueDescription
        Default value providerProviderInterfacenew Ws(defaults.WS_URL)An API provider using HTTP or WebSocket
        -

        Returns: RxApi

        -
        -

        Properties

        -

        -

        author

        -

        ● author: RxApiInterface$Section

        -

        Defined in index.ts:43

        -
        -

        -

        chain

        -

        ● chain: RxApiInterface$Section

        -

        Defined in index.ts:44

        -
        -

        -

        state

        -

        ● state: RxApiInterface$Section

        -

        Defined in index.ts:45

        -
        -

        -

        system

        -

        ● system: RxApiInterface$Section

        -

        Defined in index.ts:46

        -
        -

        Methods

        -

        -

        isConnected

        -

        ▸ isConnected(): BehaviorSubject<boolean>

        -

        Defined in index.ts:65

        -

        Returns: BehaviorSubject<boolean>

        -
        - - -
        - -
        -
        -
        - -

        results matching ""

        -
          - -
          -
          - -

          No results matching ""

          - -
          -
          -
          - -
          -
          - -
          - - - - - - - - - - - - - - -
          - - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-rx/classes/_index_.rxapi.md b/docs/api-rx/classes/_index_.rxapi.md deleted file mode 100644 index 1aadf315b8be..000000000000 --- a/docs/api-rx/classes/_index_.rxapi.md +++ /dev/null @@ -1,98 +0,0 @@ - - -*__name__*: RxApi - -*__summary__*: The RxJS API is a wrapper around the API. - -*__description__*: It allows wrapping API components with observables using RxJS. - -*__example__*: -```javascript -import RxApi from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('http://127.0.0.1:9944'); -const rxapi = new RxApi(provider); -``` - -# Hierarchy - -**RxApi** - -# Implements - -* `object` - -# Constructors - - - -## constructor - -⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](_index_.rxapi.md) - -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L46)* - -**Parameters:** - -| Param | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| `Default value` provider | `ProviderInterface` | new Ws(defaults.WS_URL) | An API provider using HTTP or WebSocket | - -**Returns:** [RxApi](_index_.rxapi.md) - -___ - -# Properties - - - -## author - -**● author**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* - -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L43)* - -___ - - -## chain - -**● chain**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* - -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L44)* - -___ - - -## state - -**● state**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* - -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L45)* - -___ - - -## system - -**● system**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)* - -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L46)* - -___ - -# Methods - - - -## isConnected - -▸ **isConnected**(): `BehaviorSubject`<`boolean`> - -*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/index.ts#L65)* - -**Returns:** `BehaviorSubject`<`boolean`> - -___ - diff --git a/docs/api-rx/index.html b/docs/api-rx/index.html deleted file mode 100644 index 28946636cb30..000000000000 --- a/docs/api-rx/index.html +++ /dev/null @@ -1,454 +0,0 @@ - - - - - - - api-rx · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          -
          - - - - - - - - -
          - -
          - -
          - - - - - - - - -
          -
          - -
          -
          - -
          - -

          polkadotjs isc style npm travis maintainability coverage dependency devDependency

          -

          @polkadot/api-rx

          -

          An RxJs wrapper around the @polkadot/api.

          - - -
          - -
          -
          -
          - -

          results matching ""

          -
            - -
            -
            - -

            No results matching ""

            - -
            -
            -
            - -
            -
            - -
            - - - - - - - - - - - - - - -
            - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-rx/modules/_defaults_.md b/docs/api-rx/modules/_defaults_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/api-rx/modules/_defaults_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/api-rx/modules/_index_.md b/docs/api-rx/modules/_index_.md deleted file mode 100644 index bec29894a860..000000000000 --- a/docs/api-rx/modules/_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [RxApi](../classes/_index_.rxapi.md) - ---- - diff --git a/docs/api-rx/modules/_types_d_.md b/docs/api-rx/modules/_types_d_.md deleted file mode 100644 index 839fc9573cd6..000000000000 --- a/docs/api-rx/modules/_types_d_.md +++ /dev/null @@ -1,49 +0,0 @@ - - -# Type aliases - - - -## RxApiInterface - -**Ƭ RxApiInterface**: *`object`* - -*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/types.d.ts#L15)* - -#### Type declaration - -___ - - -## RxApiInterface$Method - -**Ƭ RxApiInterface$Method**: *`function`* - -*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/types.d.ts#L9)* - -#### Type declaration -▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `BehaviorSubject`<`any`> - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`any`> | `BehaviorSubject`<`any`> - -___ - - -## RxApiInterface$Section - -**Ƭ RxApiInterface$Section**: *`object`* - -*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/ae54a71/packages/api-rx/src/types.d.ts#L11)* - -#### Type declaration - -[index: `string`]: [RxApiInterface$Method](_types_d_.md#rxapiinterface_method) - -___ - diff --git a/docs/api/README.md b/docs/api/README.md deleted file mode 100644 index 45ac535db45e..000000000000 --- a/docs/api/README.md +++ /dev/null @@ -1,72 +0,0 @@ - -[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api#info=devDependencies) - -@polkadot/api -============= - -This library provides a clean wrapper around all the methods exposed by a Polkadot network client. - -Usage ------ - -Installation - - -``` -npm install --save @polkadot/api -``` - -Initialisation - - -```js -import Api from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('http://127.0.0.1:9944'); -const api = new Api(provider); -``` - -Making calls - - -```js -api.chain - .getHeader('0x1234567890') - .then((header) => console.log(header)) - .catch((error) => console.error(error)); -``` - -Retrieving the best block (once-off) - - -```js -api.chain - .getHead() - .then((headerHash) => { - return api.chain.getHeader(headerHash); - }) - .then((header) => { - console.log(`best #${header.number.toString()}`); - }) - .catch((error) => { - console.error('error:', error); - }); -``` - -Retrieving best header via subscription - - -```js -api.chain - .newHead((error, header) => { - if (error) { - console.error('error:', error); - } - - console.log(`best #${header.number.toString()}`); - }) - .then((subscriptionId) => { - // id for the subscription, can unsubscribe via - // api.chain.newHead.unsubscribe(subscriptionId) - }) - .catch((error) => { - console.error('error subscribing:', error); - }); -``` - diff --git a/docs/api/SUMMARY.md b/docs/api/SUMMARY.md deleted file mode 100644 index 2ed853f1bfc7..000000000000 --- a/docs/api/SUMMARY.md +++ /dev/null @@ -1,4 +0,0 @@ -* ["index"](modules/_index_.md) - * [Api](classes/_index_.api.md) -* ["types.d"](modules/_types_d_.md) - * [ApiInterface$Section$Method](interfaces/_types_d_.apiinterface_section_method.md) diff --git a/docs/api/classes/_index_.api.html b/docs/api/classes/_index_.api.html deleted file mode 100644 index d4693864dfb6..000000000000 --- a/docs/api/classes/_index_.api.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - - - Api · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            -
            - - - - - - - - -
            - -
            - -
            - - - - - - - - -
            -
            - -
            -
            - -
            - -

            name: Api

            -

            summary: The API may use a HTTP or WebSockets provider.

            -

            description: It allows for querying a Polkadot Client Node.

            -

            example:

            -
            import Api from '@polkadot/api';
-import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
            -

            Hierarchy

            -

            Api

            -

            Implements

            -
              -
            • object
              • -
            -

            Constructors

            -

            -

            constructor

            -

            ⊕ new Api(provider: ProviderInterface): Api

            -

            Defined in index.ts:36

            -

            constructor: Default constructor for the Api Object

            -

            Parameters:

            - - - - - - - - - - - - - - - -
            ParamTypeDescription
            providerProviderInterfaceAn API provider using HTTP or WebSocket
            -

            Returns: Api

            -
            -

            Properties

            -

            -

            author

            -

            ● author: ApiInterface$Section

            -

            Defined in index.ts:33

            -
            -

            -

            chain

            -

            ● chain: ApiInterface$Section

            -

            Defined in index.ts:34

            -
            -

            -

            state

            -

            ● state: ApiInterface$Section

            -

            Defined in index.ts:35

            -
            -

            -

            system

            -

            ● system: ApiInterface$Section

            -

            Defined in index.ts:36

            -
            -

            Methods

            -

            -

            <Static> signature

            -

            ▸ signature(__namedParameters: object): string

            -

            Defined in index.ts:69

            -

            name: signature

            -

            summary: Returns a string representation of the method with inputs and outputs.

            -

            description: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type.

            -

            example:

            -
            import Api from '@polkadot/api';
-
-Api.signature({ name: 'test_method', params: [ { name: 'dest', type: 'Address' } ], type: 'Address' }); // => test_method (dest: Address): Address
-
            -

            Parameters:

            - - - - - - - - - - - - - -
            ParamType
            __namedParametersobject
            -

            Returns: string

            -
            - - -
            - -
            -
            -
            - -

            results matching ""

            -
              - -
              -
              - -

              No results matching ""

              - -
              -
              -
              - -
              -
              - -
              - - - - - - - - - - - - - - -
              - - -
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api/classes/_index_.api.md b/docs/api/classes/_index_.api.md deleted file mode 100644 index 48ee9153fcad..000000000000 --- a/docs/api/classes/_index_.api.md +++ /dev/null @@ -1,119 +0,0 @@ - - -*__name__*: Api - -*__summary__*: The API may use a HTTP or WebSockets provider. - -*__description__*: It allows for querying a Polkadot Client Node. - -*__example__*: -```javascript -import Api from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); -``` - -# Hierarchy - -**Api** - -# Implements - -* `object` - -# Constructors - - - -## constructor - -⊕ **new Api**(provider: *`ProviderInterface`*): [Api](_index_.api.md) - -*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L36)* - -*__constructor__*: Default constructor for the Api Object - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| provider | `ProviderInterface` | An API provider using HTTP or WebSocket | - -**Returns:** [Api](_index_.api.md) - -___ - -# Properties - - - -## author - -**● author**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* - -*Defined in [index.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L33)* - -___ - - -## chain - -**● chain**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* - -*Defined in [index.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L34)* - -___ - - -## state - -**● state**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* - -*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L35)* - -___ - - -## system - -**● system**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)* - -*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L36)* - -___ - -# Methods - - - -## `` signature - -▸ **signature**(__namedParameters: *`object`*): `string` - -*Defined in [index.ts:69](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/index.ts#L69)* - -*__name__*: signature - -*__summary__*: Returns a string representation of the method with inputs and outputs. - -*__description__*: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type. - -*__example__*: -```javascript -import Api from '@polkadot/api'; - -Api.signature({ name: 'test_method', params: [ { name: 'dest', type: 'Address' } ], type: 'Address' }); // => test_method (dest: Address): Address -``` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | - -**Returns:** `string` - -___ - diff --git a/docs/api/index.html b/docs/api/index.html deleted file mode 100644 index 486a3d3412b6..000000000000 --- a/docs/api/index.html +++ /dev/null @@ -1,500 +0,0 @@ - - - - - - - api · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              -
              - - - - - - - - -
              - -
              - -
              - - - - - - - - -
              -
              - -
              -
              - -
              - -

              polkadotjs isc style npm travis maintainability coverage dependency devDependency

              -

              @polkadot/api

              -

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

              -

              Usage

              -

              Installation -

              -
              npm install --save @polkadot/api
-

              Initialisation -

              -
              import Api from '@polkadot/api';
-import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('http://127.0.0.1:9944');
-const api = new Api(provider);
-
              -

              Making calls -

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

              Retrieving the best block (once-off) -

              -
              api.chain
-  .getHead()
-  .then((headerHash) => {
-    return api.chain.getHeader(headerHash);
-  })
-  .then((header) => {
-    console.log(`best #${header.number.toString()}`);
-  })
-  .catch((error) => {
-    console.error('error:', error);
-  });
-
              -

              Retrieving best header via subscription -

              -
              api.chain
-  .newHead((error, header) => {
-    if (error) {
-      console.error('error:', error);
-    }
-
-    console.log(`best #${header.number.toString()}`);
-  })
-  .then((subscriptionId) => {
-    // id for the subscription, can unsubscribe via
-    // api.chain.newHead.unsubscribe(subscriptionId)
-  })
-  .catch((error) => {
-    console.error('error subscribing:', error);
-  });
-
              - - -
              - -
              -
              -
              - -

              results matching ""

              -
                - -
                -
                - -

                No results matching ""

                - -
                -
                -
                - -
                -
                - -
                - - - - - - - - - - - - - - -
                - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_d_.apiinterface_section_method.md b/docs/api/interfaces/_types_d_.apiinterface_section_method.md deleted file mode 100644 index 7b9f004b3f31..000000000000 --- a/docs/api/interfaces/_types_d_.apiinterface_section_method.md +++ /dev/null @@ -1,51 +0,0 @@ - - -# Hierarchy - -**ApiInterface$Section$Method** - -# Callable -▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/types.d.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -# Properties - - - -## subscription - -**● subscription**: *`string`* - -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/types.d.ts#L10)* - -___ - - -## unsubscribe - -**● unsubscribe**: *`function`* - -*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/types.d.ts#L11)* - -#### Type declaration -▸(id: *`number`*): `Promise`<`any`> - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| id | `number` | - -**Returns:** `Promise`<`any`> - -___ - diff --git a/docs/api/modules/_index_.md b/docs/api/modules/_index_.md deleted file mode 100644 index 7e08da80695e..000000000000 --- a/docs/api/modules/_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Api](../classes/_index_.api.md) - ---- - diff --git a/docs/api/modules/_types_d_.md b/docs/api/modules/_types_d_.md deleted file mode 100644 index a974b7dc577e..000000000000 --- a/docs/api/modules/_types_d_.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Type aliases - - - -## ApiInterface - -**Ƭ ApiInterface**: *`object`* - -*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/types.d.ts#L18)* - -#### Type declaration - -___ - - -## ApiInterface$Section - -**Ƭ ApiInterface$Section**: *`object`* - -*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/api/src/types.d.ts#L14)* - -#### Type declaration - -[index: `string`]: [ApiInterface$Section$Method](../interfaces/_types_d_.apiinterface_section_method.md) - -___ - diff --git a/docs/examples/01_simple_connect/index.js b/docs/examples/01_simple_connect/index.js index d6cf71571e92..166b720e7f42 100755 --- a/docs/examples/01_simple_connect/index.js +++ b/docs/examples/01_simple_connect/index.js @@ -1,7 +1,7 @@ -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); async function getChain () { return api.system.chain(); diff --git a/docs/examples/01_simple_connect/package.json b/docs/examples/01_simple_connect/package.json index bdbfd99ff2f9..e857a1186c62 100644 --- a/docs/examples/01_simple_connect/package.json +++ b/docs/examples/01_simple_connect/package.json @@ -11,8 +11,8 @@ }, "dependencies": { - "@polkadot/api": "0.29.1", - "@polkadot/api-provider": "^0.29.1" + "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-provider": "^0.30.1" }, "devDependencies": { "rimraf": "^2.6.2" diff --git a/docs/examples/02_listen_to_blocks/index.js b/docs/examples/02_listen_to_blocks/index.js index 6b708d6c526a..11ee1ed17b51 100755 --- a/docs/examples/02_listen_to_blocks/index.js +++ b/docs/examples/02_listen_to_blocks/index.js @@ -1,8 +1,8 @@ const BN = require('bn.js'); -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); function main () { console.log('Blocks will be shown as they come in, CTRL+C to stop:'); diff --git a/docs/examples/02_listen_to_blocks/package.json b/docs/examples/02_listen_to_blocks/package.json index 50e21797a571..09aa8f45b31b 100644 --- a/docs/examples/02_listen_to_blocks/package.json +++ b/docs/examples/02_listen_to_blocks/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/03_listen_to_balance_change/index.js b/docs/examples/03_listen_to_balance_change/index.js index c87522518ebf..7ac81fc77bcb 100755 --- a/docs/examples/03_listen_to_balance_change/index.js +++ b/docs/examples/03_listen_to_balance_change/index.js @@ -1,9 +1,10 @@ const BN = require('bn.js'); -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const storage = require('@polkadot/storage').default; const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); + const Alice = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'; console.log('You may leave this example running and start example 06 or send DOTs to ' + Alice); diff --git a/docs/examples/03_listen_to_balance_change/package.json b/docs/examples/03_listen_to_balance_change/package.json index 050b3fec31ce..251f3b3f17d0 100644 --- a/docs/examples/03_listen_to_balance_change/package.json +++ b/docs/examples/03_listen_to_balance_change/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/04_generate_account/package.json b/docs/examples/04_generate_account/package.json index ba36320c6e1a..8c4086505926 100644 --- a/docs/examples/04_generate_account/package.json +++ b/docs/examples/04_generate_account/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "@polkadot/util": "0.30.3", "@polkadot/util-keyring": "0.30.3" }, diff --git a/docs/examples/05_read_storage/index.js b/docs/examples/05_read_storage/index.js index 1e71dfc313d5..23e3250ea10e 100755 --- a/docs/examples/05_read_storage/index.js +++ b/docs/examples/05_read_storage/index.js @@ -1,10 +1,10 @@ const BN = require('bn.js'); -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const storage = require('@polkadot/storage').default; const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); async function getAccountIndex (address) { return api.state.getStorage([storage.system.public.accountIndexOf, address]); diff --git a/docs/examples/05_read_storage/package.json b/docs/examples/05_read_storage/package.json index 1b65dd23676f..1d597e6b19fd 100644 --- a/docs/examples/05_read_storage/package.json +++ b/docs/examples/05_read_storage/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/06_craft_extrinsic/index.js b/docs/examples/06_craft_extrinsic/index.js index d35f2b123448..fb36f722bc78 100755 --- a/docs/examples/06_craft_extrinsic/index.js +++ b/docs/examples/06_craft_extrinsic/index.js @@ -1,6 +1,6 @@ const BN = require('bn.js'); -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const extrinsics = require('@polkadot/extrinsics').default; const encodeExtrinsic = require('@polkadot/extrinsics/codec/encode').default; const encodeLength = require('@polkadot/extrinsics/codec/encode/length').default; @@ -10,7 +10,7 @@ const storage = require('@polkadot/storage').default; const Encoder = new TextEncoder(); const keyring = new Keyring(); const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); async function getAccountIndex (address) { return api.state.getStorage([storage.system.public.accountIndexOf, address]); diff --git a/docs/examples/06_craft_extrinsic/package.json b/docs/examples/06_craft_extrinsic/package.json index 09d5bdef4567..4d45c436316d 100644 --- a/docs/examples/06_craft_extrinsic/package.json +++ b/docs/examples/06_craft_extrinsic/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/07_transfer_dots/index.js b/docs/examples/07_transfer_dots/index.js index 0a24bac62cbe..45a8d3b53b6c 100755 --- a/docs/examples/07_transfer_dots/index.js +++ b/docs/examples/07_transfer_dots/index.js @@ -1,6 +1,6 @@ const BN = require('bn.js'); -const Api = require('@polkadot/api').default; -const WsProvider = require('@polkadot/api-provider/ws').default; +const Rpc = require('@polkadot/rpc-core').default; +const WsProvider = require('@polkadot/rpc-provider/ws').default; const extrinsics = require('@polkadot/extrinsics').default; const encodeExtrinsic = require('@polkadot/extrinsics/codec/encode/uncheckedLength').default; const Keyring = require('@polkadot/util-keyring').default; @@ -9,7 +9,7 @@ const storage = require('@polkadot/storage').default; const Encoder = new TextEncoder(); const keyring = new Keyring(); const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); +const api = new Rpc(provider); async function getAccountIndex (address) { return api.state.getStorage([storage.system.public.accountIndexOf, address]); diff --git a/docs/examples/07_transfer_dots/package.json b/docs/examples/07_transfer_dots/package.json index a3353aaa9b0b..6141954db73b 100644 --- a/docs/examples/07_transfer_dots/package.json +++ b/docs/examples/07_transfer_dots/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/api": "0.29.1", + "@polkadot/rpc-core": "^0.30.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/guides/create_api.adoc b/docs/guides/create_api.adoc deleted file mode 100644 index 2a4749efa672..000000000000 --- a/docs/guides/create_api.adoc +++ /dev/null @@ -1,8 +0,0 @@ - -```javascript -import createApi from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = createApi(provider); -``` diff --git a/docs/guides/create_api.md b/docs/guides/create_api.md new file mode 100644 index 000000000000..9749df9ff3e5 --- /dev/null +++ b/docs/guides/create_api.md @@ -0,0 +1,8 @@ + +```javascript +import Rpc from '@polkadot/rpc-core'; +import WsProvider from '@polkadot/rpc-provider/ws'; + +const provider = new WsProvider('ws://127.0.0.1:9944'); +const rpc = new Rpc(provider); +``` diff --git a/docs/types/README.md b/docs/types/README.md deleted file mode 100644 index fc226972aee9..000000000000 --- a/docs/types/README.md +++ /dev/null @@ -1,6 +0,0 @@ - -@polkadot/types -=============== - -Implementation of the types and their serialisation via parity-codec - diff --git a/docs/types/SUMMARY.md b/docs/types/SUMMARY.md deleted file mode 100644 index 20d8771ffcc3..000000000000 --- a/docs/types/SUMMARY.md +++ /dev/null @@ -1,158 +0,0 @@ -* ["AccountId"](modules/_accountid_.md) - * [AccountId](classes/_accountid_.accountid.md) -* ["AccountIndex"](modules/_accountindex_.md) - * [AccountIndex](classes/_accountindex_.accountindex.md) -* ["Address"](modules/_address_.md) - * [Address](classes/_address_.address.md) -* ["AuthorityId"](modules/_authorityid_.md) - * [AuthorityId](classes/_authorityid_.authorityid.md) -* ["Balance"](modules/_balance_.md) - * [Balance](classes/_balance_.balance.md) -* ["Bft"](modules/_bft_.md) - * [BftAuthoritySignature](classes/_bft_.bftauthoritysignature.md) - * [BftHashSignature](classes/_bft_.bfthashsignature.md) - * [Justification](classes/_bft_.justification.md) -* ["Block"](modules/_block_.md) - * [Block](classes/_block_.block.md) -* ["BlockNumber"](modules/_blocknumber_.md) - * [BlockNumber](classes/_blocknumber_.blocknumber.md) -* ["Bool"](modules/_bool_.md) - * [Bool](classes/_bool_.bool.md) -* ["Bytes"](modules/_bytes_.md) - * [Bytes](classes/_bytes_.bytes.md) -* ["Extrinsic"](modules/_extrinsic_.md) - * [Extrinsic](classes/_extrinsic_.extrinsic.md) -* ["ExtrinsicEra"](modules/_extrinsicera_.md) - * [ExtrinsicEra](classes/_extrinsicera_.extrinsicera.md) -* ["ExtrinsicSignature"](modules/_extrinsicsignature_.md) - * [ExtrinsicSignature](classes/_extrinsicsignature_.extrinsicsignature.md) -* ["Extrinsics"](modules/_extrinsics_.md) - * [Extrinsics](classes/_extrinsics_.extrinsics.md) -* ["Gas"](modules/_gas_.md) - * [Gas](classes/_gas_.gas.md) -* ["H256"](modules/_h256_.md) - * [H256](classes/_h256_.h256.md) -* ["H512"](modules/_h512_.md) - * [H512](classes/_h512_.h512.md) -* ["Hash"](modules/_hash_.md) - * [Hash](classes/_hash_.hash.md) -* ["Header"](modules/_header_.md) - * [Digest](classes/_header_.digest.md) - * [Header](classes/_header_.header.md) -* ["KeyValue"](modules/_keyvalue_.md) - * [KeyValue](classes/_keyvalue_.keyvalue.md) - * [KeyValueOption](classes/_keyvalue_.keyvalueoption.md) -* ["Metadata"](modules/_metadata_.md) - * [CallMetadata](classes/_metadata_.callmetadata.md) - * [EventMetadata](classes/_metadata_.eventmetadata.md) - * [FunctionArgumentMetadata](classes/_metadata_.functionargumentmetadata.md) - * [FunctionMetadata](classes/_metadata_.functionmetadata.md) - * [ModuleMetadata](classes/_metadata_.modulemetadata.md) - * [OuterEventMetadata](classes/_metadata_.outereventmetadata.md) - * [OuterEventMetadataEvent](classes/_metadata_.outereventmetadataevent.md) - * [RuntimeMetadata](classes/_metadata_.runtimemetadata.md) - * [RuntimeModuleMetadata](classes/_metadata_.runtimemodulemetadata.md) - * [StorageFunctionMetadata](classes/_metadata_.storagefunctionmetadata.md) - * [StorageFunctionModifier](classes/_metadata_.storagefunctionmodifier.md) - * [StorageFunctionType](classes/_metadata_.storagefunctiontype.md) - * [StorageFunctionType$Map](classes/_metadata_.storagefunctiontype_map.md) - * [StorageMetadata](classes/_metadata_.storagemetadata.md) -* ["Metadata.rpc"](modules/_metadata_rpc_.md) -* ["Method"](modules/_method_.md) - * [Method](classes/_method_.method.md) -* ["MethodIndex"](modules/_methodindex_.md) - * [MethodIndex](classes/_methodindex_.methodindex.md) -* ["MisbehaviorReport"](modules/_misbehaviorreport_.md) - * [BftAtReport](classes/_misbehaviorreport_.bftatreport.md) - * [BftDoubleCommit](classes/_misbehaviorreport_.bftdoublecommit.md) - * [BftDoublePrepare](classes/_misbehaviorreport_.bftdoubleprepare.md) - * [MisbehaviorKind](classes/_misbehaviorreport_.misbehaviorkind.md) - * [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md) -* ["Moment"](modules/_moment_.md) - * [Moment](classes/_moment_.moment.md) -* ["NewAccountOutcome"](modules/_newaccountoutcome_.md) - * [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md) -* ["Nonce"](modules/_nonce_.md) - * [Index](classes/_nonce_.index.md) -* ["Origin"](modules/_origin_.md) - * [Origin](classes/_origin_.origin.md) -* ["ParachainId"](modules/_parachainid_.md) - * [ParachainId](classes/_parachainid_.parachainid.md) -* ["PendingExtrinsics"](modules/_pendingextrinsics_.md) - * [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md) -* ["Perbill"](modules/_perbill_.md) - * [Perbill](classes/_perbill_.perbill.md) -* ["Permill"](modules/_permill_.md) - * [Permill](classes/_permill_.permill.md) -* ["PropIndex"](modules/_propindex_.md) - * [PropIndex](classes/_propindex_.propindex.md) -* ["Proposal"](modules/_proposal_.md) - * [Proposal](classes/_proposal_.proposal.md) -* ["ProposalIndex"](modules/_proposalindex_.md) - * [ProposalIndex](classes/_proposalindex_.proposalindex.md) -* ["ReferendumIndex"](modules/_referendumindex_.md) - * [ReferendumIndex](classes/_referendumindex_.referendumindex.md) -* ["RuntimeVersion"](modules/_runtimeversion_.md) - * [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md) -* ["Signature"](modules/_signature_.md) - * [Signature](classes/_signature_.signature.md) -* ["SignaturePayload"](modules/_signaturepayload_.md) - * [SignaturePayload](classes/_signaturepayload_.signaturepayload.md) -* ["SignedBlock"](modules/_signedblock_.md) - * [SignedBlock](classes/_signedblock_.signedblock.md) -* ["StorageChangeSet"](modules/_storagechangeset_.md) - * [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md) -* ["StorageData"](modules/_storagedata_.md) - * [StorageData](classes/_storagedata_.storagedata.md) -* ["StorageKey"](modules/_storagekey_.md) - * [StorageKey](classes/_storagekey_.storagekey.md) - * [StorageFunction](interfaces/_storagekey_.storagefunction.md) -* ["Text"](modules/_text_.md) - * [Text](classes/_text_.text.md) -* ["Type"](modules/_type_.md) - * [Type](classes/_type_.type.md) -* ["U128"](modules/_u128_.md) - * [U128](classes/_u128_.u128.md) -* ["U16"](modules/_u16_.md) - * [U16](classes/_u16_.u16.md) -* ["U256"](modules/_u256_.md) - * [U256](classes/_u256_.u256.md) -* ["U32"](modules/_u32_.md) - * [U32](classes/_u32_.u32.md) -* ["U64"](modules/_u64_.md) - * [U64](classes/_u64_.u64.md) -* ["U8"](modules/_u8_.md) - * [U8](classes/_u8_.u8.md) -* ["ValidatorPrefs"](modules/_validatorprefs_.md) - * [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md) -* ["VoteIndex"](modules/_voteindex_.md) - * [VoteIndex](classes/_voteindex_.voteindex.md) -* ["VoteThreshold"](modules/_votethreshold_.md) - * [VoteThreshold](classes/_votethreshold_.votethreshold.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/Option"](modules/_codec_option_.md) - * [Option](classes/_codec_option_.option.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/index"](modules/_codec_index_.md) -* ["index"](modules/_index_.md) -* ["types.d"](modules/_types_d_.md) diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md deleted file mode 100644 index 4483aaef668e..000000000000 --- a/docs/types/classes/_accountid_.accountid.md +++ /dev/null @@ -1,223 +0,0 @@ - - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ AccountId** - -↳ [AuthorityId](_authorityid_.authorityid.md) - -# Constructors - - - -## constructor - -⊕ **new AccountId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountId](_accountid_.accountid.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L20)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AccountId](_accountid_.accountid.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [AccountId](_accountid_.accountid.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L50)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [AccountId](_accountid_.accountid.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L56)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L60)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` - -*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `string` | `Uint8Array` | `Array`<`number`>| - -**Returns:** `Uint8Array` - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md deleted file mode 100644 index 38598a104b19..000000000000 --- a/docs/types/classes/_accountindex_.accountindex.md +++ /dev/null @@ -1,227 +0,0 @@ - - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ AccountIndex** - -# Constructors - - - -## constructor - -⊕ **new AccountIndex**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountIndex](_accountindex_.accountindex.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L15)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AccountIndex](_accountindex_.accountindex.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L29)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [AccountIndex](_accountindex_.accountindex.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [AccountIndex.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L51)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [AccountIndex](_accountindex_.accountindex.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [AccountIndex](_accountindex_.accountindex.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [AccountIndex.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L57)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [AccountIndex](_accountindex_.accountindex.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [AccountIndex.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L65)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [AccountIndex.ts:69](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L69)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` - -*Defined in [AccountIndex.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `string` | `Uint8Array` | `Array`<`number`>| - -**Returns:** `Uint8Array` - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L26)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - - -## `` readLength - -▸ **readLength**(input: *`Uint8Array`*): `number` - -*Defined in [AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountIndex.ts#L35)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** `number` - -___ - diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md deleted file mode 100644 index 464b867025d8..000000000000 --- a/docs/types/classes/_address_.address.md +++ /dev/null @@ -1,161 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)< [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md)> - -**↳ Address** - -# Constructors - - - -## constructor - -⊕ **new Address**(value?: * [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`*): [Address](_address_.address.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [Address.ts:21](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L21)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Address](_address_.address.md) | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array`| new Uint8Array() | - -**Returns:** [Address](_address_.address.md) - -___ - -# Properties - - - -## raw - -**● raw**: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [Address.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L48)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Address](_address_.address.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [Address.ts:56](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L56)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Address](_address_.address.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Address](_address_.address.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [Address.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L62)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Address](_address_.address.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [Address.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L70)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [Address.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L74)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L78)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: * [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) - -*Defined in [Address.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Address.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) | `string` | `Uint8Array` | `Array`<`number`>| - -**Returns:** [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) - -___ - diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md deleted file mode 100644 index ef6bd8c9e2d4..000000000000 --- a/docs/types/classes/_authorityid_.authorityid.md +++ /dev/null @@ -1,235 +0,0 @@ - - -# Hierarchy - -↳ [AccountId](_accountid_.accountid.md) - -**↳ AuthorityId** - -# Constructors - - - -## constructor - -⊕ **new AuthorityId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AuthorityId](_authorityid_.authorityid.md) - -*Inherited from [AccountId](_accountid_.accountid.md).[constructor](_accountid_.accountid.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L20)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AuthorityId](_authorityid_.authorityid.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md) - -*Inherited from [AccountId](_accountid_.accountid.md).[fromJSON](_accountid_.accountid.md#fromjson)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [AccountId](_accountid_.accountid.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md) - -*Inherited from [AccountId](_accountid_.accountid.md).[fromU8a](_accountid_.accountid.md#fromu8a)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L50)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [AccountId](_accountid_.accountid.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [AccountId](_accountid_.accountid.md).[toJSON](_accountid_.accountid.md#tojson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L56)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [AccountId](_accountid_.accountid.md).[toString](_accountid_.accountid.md#tostring)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L60)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: * `string` | `Uint8Array` | `Array`<`number`>*): `Uint8Array` - -*Inherited from [AccountId](_accountid_.accountid.md).[decode](_accountid_.accountid.md#decode)* - -*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `string` | `Uint8Array` | `Array`<`number`>| - -**Returns:** `Uint8Array` - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* - -*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/AccountId.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md deleted file mode 100644 index 36a950fb0518..000000000000 --- a/docs/types/classes/_balance_.balance.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U128](_u128_.u128.md) - -**↳ Balance** - -# Constructors - - - -## constructor - -⊕ **new Balance**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Balance](_balance_.balance.md) - -*Inherited from [U128](_u128_.u128.md).[constructor](_u128_.u128.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U128.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [Balance](_balance_.balance.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md deleted file mode 100644 index da739f6dfa24..000000000000 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ /dev/null @@ -1,315 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ BftAuthoritySignature** - -# Constructors - - - -## constructor - -⊕ **new BftAuthoritySignature**(value?: *[BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue)*): [BftAuthoritySignature](_bft_.bftauthoritysignature.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue) | - -**Returns:** [BftAuthoritySignature](_bft_.bftauthoritysignature.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## authorityId - -getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) - -*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L30)* - -**Returns:** [AuthorityId](_authorityid_.authorityid.md) - -___ - - -## signature - -getsignature(): [Signature](_signature_.signature.md) - -*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L34)* - -**Returns:** [Signature](_signature_.signature.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L46)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L24)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md deleted file mode 100644 index 70cf8d8057fe..000000000000 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ /dev/null @@ -1,315 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ BftHashSignature** - -# Constructors - - - -## constructor - -⊕ **new BftHashSignature**(value?: *[BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue)*): [BftHashSignature](_bft_.bfthashsignature.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L46)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue) | - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L54)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## signature - -getsignature(): [Signature](_signature_.signature.md) - -*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L58)* - -**Returns:** [Signature](_signature_.signature.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L46)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L24)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_bft_.justification.md b/docs/types/classes/_bft_.justification.md deleted file mode 100644 index 00ffe04821dc..000000000000 --- a/docs/types/classes/_bft_.justification.md +++ /dev/null @@ -1,324 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Justification** - -# Constructors - - - -## constructor - -⊕ **new Justification**(value?: *[JustificationValue](../modules/_bft_.md#justificationvalue)*): [Justification](_bft_.justification.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L69)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [JustificationValue](../modules/_bft_.md#justificationvalue) | - -**Returns:** [Justification](_bft_.justification.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L80)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## round - -getround(): [U32](_u32_.u32.md) - -*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L84)* - -**Returns:** [U32](_u32_.u32.md) - -___ - - -## signatures - -getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> - -*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L88)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md deleted file mode 100644 index d1aa5a63dc4e..000000000000 --- a/docs/types/classes/_block_.block.md +++ /dev/null @@ -1,324 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Block** - -# Constructors - - - -## constructor - -⊕ **new Block**(value?: *[BlockValue](../modules/_block_.md#blockvalue)*): [Block](_block_.block.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Block.ts#L20)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [BlockValue](../modules/_block_.md#blockvalue) | - -**Returns:** [Block](_block_.block.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## extrinsics - -getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) - -*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Block.ts#L28)* - -**Returns:** [Extrinsics](_extrinsics_.extrinsics.md) - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Block.ts#L33)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## header - -getheader(): [Header](_header_.header.md) - -*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Block.ts#L39)* - -**Returns:** [Header](_header_.header.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md deleted file mode 100644 index 21bebf9c6a79..000000000000 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U64](_u64_.u64.md) - -**↳ BlockNumber** - -# Constructors - - - -## constructor - -⊕ **new BlockNumber**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [BlockNumber](_blocknumber_.blocknumber.md) - -*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U64.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md deleted file mode 100644 index b161a47d7620..000000000000 --- a/docs/types/classes/_bool_.bool.md +++ /dev/null @@ -1,143 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`boolean`> - -**↳ Bool** - -# Constructors - - - -## constructor - -⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | `boolean`*): [Bool](_bool_.bool.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [Bool.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L7)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Bool](_bool_.bool.md) | `boolean`| false | - -**Returns:** [Bool](_bool_.bool.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`boolean`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L16)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Bool](_bool_.bool.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [Bool.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L20)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Bool](_bool_.bool.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Bool](_bool_.bool.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L26)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Bool](_bool_.bool.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [Bool.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L32)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [Bool.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L40)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [Bool.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bool.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md deleted file mode 100644 index fa9a19977a84..000000000000 --- a/docs/types/classes/_bytes_.bytes.md +++ /dev/null @@ -1,184 +0,0 @@ - - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ Bytes** - -↳ [StorageData](_storagedata_.storagedata.md) - -↳ [StorageKey](_storagekey_.storagekey.md) - -# Constructors - - - -## constructor - -⊕ **new Bytes**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Bytes](_bytes_.bytes.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L16)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [Bytes](_bytes_.bytes.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L14)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L18)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [Bytes.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Bytes](_bytes_.bytes.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [Bytes.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md deleted file mode 100644 index 3e042887d5b9..000000000000 --- a/docs/types/classes/_codec_base_.base.md +++ /dev/null @@ -1,151 +0,0 @@ - - -# Type parameters -#### T -# Hierarchy - -**Base** - -↳ [U8a](_codec_u8a_.u8a.md) - -↳ [Address](_address_.address.md) - -↳ [UInt](_codec_uint_.uint.md) - -↳ [Struct](_codec_struct_.struct.md) - -↳ [Vector](_codec_vector_.vector.md) - -↳ [Text](_text_.text.md) - -↳ [Enum](_codec_enum_.enum.md) - -↳ [EnumType](_codec_enumtype_.enumtype.md) - -↳ [Option](_codec_option_.option.md) - -↳ [Bool](_bool_.bool.md) - -↳ [Moment](_moment_.moment.md) - -↳ [Origin](_origin_.origin.md) - -# Constructors - - - -## constructor - -⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`T`* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L25)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`> - -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Base](_codec_base_.base.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`> - -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Base](_codec_base_.base.md)<`T`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L37)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L41)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md deleted file mode 100644 index 0912b550f1da..000000000000 --- a/docs/types/classes/_codec_compact_.compact.md +++ /dev/null @@ -1,45 +0,0 @@ - - -# Hierarchy - -**Compact** - -# Methods - - - -## `` decode - -▸ **decode**(_input: * `Uint8Array` | `string`*, bitLength?: *`BitLength`*): [`number`, `BN`] - -*Defined in [codec/Compact.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Compact.ts#L38)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| _input | `Uint8Array` | `string`| - | -| `Default value` bitLength | `BitLength` | DEFAULT_BITLENGTH | - -**Returns:** [`number`, `BN`] - -___ - - -## `` encode - -▸ **encode**(_length: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*, bitLength?: *`BitLength`*): `Uint8Array` - -*Defined in [codec/Compact.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Compact.ts#L55)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| _length | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - | -| `Default value` bitLength | `BitLength` | DEFAULT_BITLENGTH | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md deleted file mode 100644 index 48f47ce62e89..000000000000 --- a/docs/types/classes/_codec_enum_.enum.md +++ /dev/null @@ -1,161 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`number`> - -**↳ Enum** - -↳ [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) - -↳ [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) - -↳ [VoteThreshold](_votethreshold_.votethreshold.md) - -# Constructors - - - -## constructor - -⊕ **new Enum**(def: *`EnumDef`*, value?: * [Enum](_codec_enum_.enum.md) | `number`*): [Enum](_codec_enum_.enum.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Enum.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L19)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| def | `EnumDef` | - | -| `Default value` value | [Enum](_codec_enum_.enum.md) | `number`| 0 | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`number`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L31)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L35)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L49)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L57)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L61)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md deleted file mode 100644 index ba8530459405..000000000000 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ /dev/null @@ -1,194 +0,0 @@ - - -# Type parameters -#### T -# Hierarchy - - [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> - -**↳ EnumType** - -↳ [StorageFunctionType](_metadata_.storagefunctiontype.md) - -↳ [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) - -# Constructors - - - -## constructor - -⊕ **new EnumType**(def: *`TypesDef`*, index?: * `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>*, value?: *`any`*): [EnumType](_codec_enumtype_.enumtype.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/EnumType.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| def | `TypesDef` | -| `Optional` index | `number` | [EnumType](_codec_enumtype_.enumtype.md)<`T`>| -| `Optional` value | `any` | - -**Returns:** [EnumType](_codec_enumtype_.enumtype.md) - -___ - -# Properties - - - -## raw - -**● raw**: *[Base](_codec_base_.base.md)<`T`>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L40)* - -**Returns:** `string` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L44)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> - -*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)<`T`> - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [EnumType](_codec_enumtype_.enumtype.md)<`T`> - -___ - - -## setValue - -▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`*, value?: *`any`*): `void` - -*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L55)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)<`T`> | `number`| -| `Optional` value | `any` | - -**Returns:** `void` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L72)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L76)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L80)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md deleted file mode 100644 index 76b0bb6813fe..000000000000 --- a/docs/types/classes/_codec_option_.option.md +++ /dev/null @@ -1,191 +0,0 @@ - - -# Type parameters -#### T -# Hierarchy - - [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>> - -**↳ Option** - -# Constructors - - - -## constructor - -⊕ **new Option**(Value: *`object`*, value?: *`any`*): [Option](_codec_option_.option.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Option.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L14)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Value | `object` | -| `Optional` value | `any` | - -**Returns:** [Option](_codec_option_.option.md) - -___ - -# Properties - - - -## raw - -**● raw**: *[Base](_codec_base_.base.md)<`T`>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## isEmpty - -getisEmpty(): `boolean` - -*Defined in [codec/Option.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L32)* - -**Returns:** `boolean` - -___ - - -## value - -getvalue(): `T` | `undefined` - -*Defined in [codec/Option.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L36)* - -**Returns:** `T` | `undefined` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L42)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Option](_codec_option_.option.md)<`T`> - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L50)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Option](_codec_option_.option.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Option](_codec_option_.option.md)<`T`> - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L60)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Option](_codec_option_.option.md)<`T`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Option.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L70)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Option.ts:91](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L91)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Option.ts:76](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L76)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`O`>(Type: *`object`*): `object` - -*Defined in [codec/Option.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Option.ts#L24)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Type | `object` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md deleted file mode 100644 index ac7a22444d34..000000000000 --- a/docs/types/classes/_codec_struct_.struct.md +++ /dev/null @@ -1,320 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - - [Base](_codec_base_.base.md)<`T`> - -**↳ Struct** - -↳ [Tuple](_codec_tuple_.tuple.md) - -↳ [EventMetadata](_metadata_.eventmetadata.md) - -↳ [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) - -↳ [OuterEventMetadata](_metadata_.outereventmetadata.md) - -↳ [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) - -↳ [FunctionMetadata](_metadata_.functionmetadata.md) - -↳ [CallMetadata](_metadata_.callmetadata.md) - -↳ [ModuleMetadata](_metadata_.modulemetadata.md) - -↳ [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) - -↳ [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) - -↳ [StorageMetadata](_metadata_.storagemetadata.md) - -↳ [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) - -↳ [RuntimeMetadata](_metadata_.runtimemetadata.md) - -↳ [SignaturePayload](_signaturepayload_.signaturepayload.md) - -↳ [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -↳ [Extrinsic](_extrinsic_.extrinsic.md) - -↳ [Digest](_header_.digest.md) - -↳ [Header](_header_.header.md) - -↳ [Block](_block_.block.md) - -↳ [KeyValue](_keyvalue_.keyvalue.md) - -↳ [Justification](_bft_.justification.md) - -↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) - -↳ [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) - -↳ [RuntimeVersion](_runtimeversion_.runtimeversion.md) - -↳ [SignedBlock](_signedblock_.signedblock.md) - -↳ [StorageChangeSet](_storagechangeset_.storagechangeset.md) - -↳ [ValidatorPrefs](_validatorprefs_.validatorprefs.md) - -# Constructors - - - -## constructor - -⊕ **new Struct**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*, isTuple?: *`boolean`*): [Struct](_codec_struct_.struct.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| Types | `S` | - | -| `Default value` value | `V` | `Array`<`any`>| {} as V | -| `Default value` jsonMap | `Map`<`keyof S`, `string`> | new Map() | -| `Default value` isTuple | `boolean` | false | - -**Returns:** [Struct](_codec_struct_.struct.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md deleted file mode 100644 index 5b9c7c0de990..000000000000 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ /dev/null @@ -1,295 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`> - -**↳ Tuple** - -↳ [KeyValueOption](_keyvalue_.keyvalueoption.md) - -↳ [BftAuthoritySignature](_bft_.bftauthoritysignature.md) - -↳ [BftHashSignature](_bft_.bfthashsignature.md) - -# Constructors - - - -## constructor - -⊕ **new Tuple**(Types: *`S`*, value?: * `V` | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Tuple](_codec_tuple_.tuple.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [codec/Tuple.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| `Optional` value | `V` | `Array`<`any`>| -| `Optional` jsonMap | `Map`<`keyof S`, `string`> | - -**Returns:** [Tuple](_codec_tuple_.tuple.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L46)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L24)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md deleted file mode 100644 index cfa6e07a27a0..000000000000 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ /dev/null @@ -1,174 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`Uint8Array`> - -**↳ U8a** - -↳ [AccountIndex](_accountindex_.accountindex.md) - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -↳ [Bytes](_bytes_.bytes.md) - -# Constructors - - - -## constructor - -⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L16)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L29)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8a](_codec_u8a_.u8a.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L39)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md deleted file mode 100644 index 21e11f6588cd..000000000000 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ /dev/null @@ -1,198 +0,0 @@ - - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ U8aFixed** - -↳ [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -↳ [MethodIndex](_methodindex_.methodindex.md) - -↳ [H512](_h512_.h512.md) - -↳ [H256](_h256_.h256.md) - -↳ [AccountId](_accountid_.accountid.md) - -# Constructors - - - -## constructor - -⊕ **new U8aFixed**(value?: *[AnyU8a](../modules/_types_d_.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:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | -| `Default value` bitLength | `BitLength` | 256 | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**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 84be1d4633c0..000000000000 --- a/docs/types/classes/_codec_uint_.uint.md +++ /dev/null @@ -1,371 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`BN`> - -**↳ UInt** - -↳ [U128](_u128_.u128.md) - -↳ [U16](_u16_.u16.md) - -↳ [U64](_u64_.u64.md) - -↳ [U32](_u32_.u32.md) - -↳ [U8](_u8_.u8.md) - -↳ [U256](_u256_.u256.md) - -# Constructors - - - -## constructor - -⊕ **new UInt**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*, bitLength?: *`BitLength`*, isHexJson?: *`boolean`*): [UInt](_codec_uint_.uint.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/UInt.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L29)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyNumber](../modules/_types_d_.md#anynumber) | 0 | -| `Default value` bitLength | `BitLength` | 64 | -| `Default value` isHexJson | `boolean` | true | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md deleted file mode 100644 index 265203f83678..000000000000 --- a/docs/types/classes/_codec_vector_.vector.md +++ /dev/null @@ -1,319 +0,0 @@ - - -# Type parameters -#### T : [Base](_codec_base_.base.md) -# Hierarchy - - [Base](_codec_base_.base.md)<`Array`<`T`>> - -**↳ Vector** - -↳ [Extrinsics](_extrinsics_.extrinsics.md) - -# Constructors - - - -## constructor - -⊕ **new Vector**(Type: *`object`*, value?: *`Array`<`any`>*): [Vector](_codec_vector_.vector.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Vector.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L18)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| Type | `object` | - | -| `Default value` value | `Array`<`any`> | [] as Array<any> | - -**Returns:** [Vector](_codec_vector_.vector.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Array`<`T`>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Defined in [codec/Vector.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L40)* - -**Returns:** `string` - -___ - - -## length - -getlength(): `number` - -*Defined in [codec/Vector.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L44)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L48)* - -**Returns:** `number` - -___ - - -## filter - -▸ **filter**(fn: *`function`*): `Array`<`T`> - -*Defined in [codec/Vector.ts:54](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L54)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**(fn: *`function`*): `T` | `undefined` - -*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L58)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `T` | `undefined` - -___ - - -## forEach - -▸ **forEach**(fn: *`function`*): `any` - -*Defined in [codec/Vector.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L62)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `any` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L66)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L74)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## get - -▸ **get**(index: *`number`*): `T` - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L90)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `T` - -___ - - -## map - -▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> - -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L94)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`O`> - -___ - - -## push - -▸ **push**(item: *`T`*): `void` - -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L98)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| item | `T` | - -**Returns:** `void` - -___ - - -## reduce - -▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` - -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L102)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | -| initial | `O` | - -**Returns:** `O` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L106)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L125)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Vector.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`O`>(Type: *`object`*): `object` - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### O : [Base](_codec_base_.base.md) -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Type | `object` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md deleted file mode 100644 index 38855f4139c7..000000000000 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ /dev/null @@ -1,410 +0,0 @@ - - -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 -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Extrinsic** - -↳ [Proposal](_proposal_.proposal.md) - -# Constructors - - - -## constructor - -⊕ **new Extrinsic**(value?: *`ExtrinsicValue`*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Extrinsic.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L38)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `ExtrinsicValue` | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## callIndex - -getcallIndex(): `Uint8Array` - -*Defined in [Extrinsic.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L47)* - -**Returns:** `Uint8Array` - -___ - - -## data - -getdata(): `Uint8Array` - -*Defined in [Extrinsic.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L51)* - -**Returns:** `Uint8Array` - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [Extrinsic.ts:56](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L56)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## isSigned - -getisSigned(): `boolean` - -*Defined in [Extrinsic.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L62)* - -**Returns:** `boolean` - -___ - - -## length - -getlength(): `number` - -*Defined in [Extrinsic.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L66)* - -**Returns:** `number` - -___ - - -## meta - -getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) - -*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L70)* - -**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) - -___ - - -## method - -getmethod(): [Method](_method_.method.md) - -*Defined in [Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L74)* - -**Returns:** [Method](_method_.method.md) - -___ - - -## signature - -getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L78)* - -**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Defined in [Extrinsic.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L82)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [Extrinsic.ts:88](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L88)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Overrides [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Defined in [Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L94)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## sign - -▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_d_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Defined in [Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| signerPair | `KeyringPair` | -| nonce | [AnyNumber](../modules/_types_d_.md#anynumber) | -| blockHash | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Defined in [Extrinsic.ts:119](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L119)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L123)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L108)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md deleted file mode 100644 index 7d493ca4a878..000000000000 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ /dev/null @@ -1,195 +0,0 @@ - - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ ExtrinsicEra** - -# Constructors - - - -## constructor - -⊕ **new ExtrinsicEra**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicEra.ts#L11)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md deleted file mode 100644 index cba65df6298a..000000000000 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ /dev/null @@ -1,353 +0,0 @@ - - -# Type parameters -#### T : [Base](_codec_base_.base.md) -# Hierarchy - -↳ [Vector](_codec_vector_.vector.md) - -**↳ Extrinsics** - -↳ [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) - -# Constructors - - - -## constructor - -⊕ **new Extrinsics**(Type: *`object`*, value?: *`Array`<`any`>*): [Extrinsics](_extrinsics_.extrinsics.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Vector.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L18)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| Type | `object` | - | -| `Default value` value | `Array`<`any`> | [] as Array<any> | - -**Returns:** [Extrinsics](_extrinsics_.extrinsics.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Array`<`T`>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L40)* - -**Returns:** `string` - -___ - - -## length - -getlength(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Defined in [codec/Vector.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L44)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[byteLength](_codec_vector_.vector.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L48)* - -**Returns:** `number` - -___ - - -## filter - -▸ **filter**(fn: *`function`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Defined in [codec/Vector.ts:54](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L54)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**(fn: *`function`*): `T` | `undefined` - -*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* - -*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L58)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `T` | `undefined` - -___ - - -## forEach - -▸ **forEach**(fn: *`function`*): `any` - -*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* - -*Defined in [codec/Vector.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L62)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `any` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[fromJSON](_codec_vector_.vector.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L66)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[fromU8a](_codec_vector_.vector.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L74)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## get - -▸ **get**(index: *`number`*): `T` - -*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L90)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `T` - -___ - - -## map - -▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L94)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`O`> - -___ - - -## push - -▸ **push**(item: *`T`*): `void` - -*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* - -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L98)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| item | `T` | - -**Returns:** `void` - -___ - - -## reduce - -▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` - -*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* - -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L102)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | -| initial | `O` | - -**Returns:** `O` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L106)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L125)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Vector.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`O`>(Type: *`object`*): `object` - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### O : [Base](_codec_base_.base.md) -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Type | `object` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md deleted file mode 100644 index fa05cb809d36..000000000000 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ /dev/null @@ -1,372 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ExtrinsicSignature** - -# Constructors - - - -## constructor - -⊕ **new ExtrinsicSignature**(value?: *`ExtrinsicSignatureValue`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `ExtrinsicSignatureValue` | - -**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## era - -getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -*Defined in [ExtrinsicSignature.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L59)* - -**Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -___ - - -## isSigned - -getisSigned(): `boolean` - -*Defined in [ExtrinsicSignature.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L55)* - -**Returns:** `boolean` - -___ - - -## nonce - -getnonce(): `Nonce` - -*Defined in [ExtrinsicSignature.ts:63](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L63)* - -**Returns:** `Nonce` - -___ - - -## signature - -getsignature(): [Signature](_signature_.signature.md) - -*Defined in [ExtrinsicSignature.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L67)* - -**Returns:** [Signature](_signature_.signature.md) - -___ - - -## signer - -getsigner(): [Address](_address_.address.md) - -*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L71)* - -**Returns:** [Address](_address_.address.md) - -___ - - -## version - -getversion(): `number` - -*Defined in [ExtrinsicSignature.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L75)* - -**Returns:** `number` - -___ - -# Methods - - - -## addSignature - -▸ **addSignature**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_d_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_d_.md#anyu8a)*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -*Defined in [ExtrinsicSignature.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L87)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| method | [Method](_method_.method.md) | - | -| signerPair | `KeyringPair` | - | -| nonce | [AnyNumber](../modules/_types_d_.md#anynumber) | - | -| blockHash | [AnyU8a](../modules/_types_d_.md#anyu8a) | - | -| `Default value` era | `Uint8Array` | IMMORTAL_ERA | - -**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Defined in [ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L46)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -*Overrides [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Defined in [ExtrinsicSignature.ts:106](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L106)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [ExtrinsicSignature.ts:119](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ExtrinsicSignature.ts#L119)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md deleted file mode 100644 index 553e78ad7cc3..000000000000 --- a/docs/types/classes/_gas_.gas.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U64](_u64_.u64.md) - -**↳ Gas** - -# Constructors - - - -## constructor - -⊕ **new Gas**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Gas](_gas_.gas.md) - -*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U64.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [Gas](_gas_.gas.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md deleted file mode 100644 index 47647a9ba22b..000000000000 --- a/docs/types/classes/_h256_.h256.md +++ /dev/null @@ -1,197 +0,0 @@ - - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ H256** - -↳ [Hash](_hash_.hash.md) - -# Constructors - - - -## constructor - -⊕ **new H256**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H256](_h256_.h256.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/H256.ts#L11)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [H256](_h256_.h256.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md deleted file mode 100644 index 7399a508c571..000000000000 --- a/docs/types/classes/_h512_.h512.md +++ /dev/null @@ -1,197 +0,0 @@ - - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ H512** - -↳ [Signature](_signature_.signature.md) - -# Constructors - - - -## constructor - -⊕ **new H512**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H512](_h512_.h512.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/H512.ts#L10)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [H512](_h512_.h512.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md deleted file mode 100644 index db73ca84cc13..000000000000 --- a/docs/types/classes/_hash_.hash.md +++ /dev/null @@ -1,197 +0,0 @@ - - -# Hierarchy - -↳ [H256](_h256_.h256.md) - -**↳ Hash** - -# Constructors - - - -## constructor - -⊕ **new Hash**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Hash](_hash_.hash.md) - -*Inherited from [H256](_h256_.h256.md).[constructor](_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/H256.ts#L11)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [Hash](_hash_.hash.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_header_.digest.md b/docs/types/classes/_header_.digest.md deleted file mode 100644 index e800f8d5191d..000000000000 --- a/docs/types/classes/_header_.digest.md +++ /dev/null @@ -1,302 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Digest** - -# Constructors - - - -## constructor - -⊕ **new Digest**(value?: *`DigestValue`*): [Digest](_header_.digest.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `DigestValue` | - -**Returns:** [Digest](_header_.digest.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## logs - -getlogs(): [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)> - -*Defined in [Header.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L36)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)> - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md deleted file mode 100644 index ae84ac423fce..000000000000 --- a/docs/types/classes/_header_.header.md +++ /dev/null @@ -1,357 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Header** - -# Constructors - - - -## constructor - -⊕ **new Header**(value?: *[HeaderValue](../modules/_header_.md#headervalue)*): [Header](_header_.header.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Header.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [HeaderValue](../modules/_header_.md#headervalue) | - -**Returns:** [Header](_header_.header.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## blockNumber - -getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) - -*Defined in [Header.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L53)* - -**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) - -___ - - -## digest - -getdigest(): [Digest](_header_.digest.md) - -*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L57)* - -**Returns:** [Digest](_header_.digest.md) - -___ - - -## extrinsicsRoot - -getextrinsicsRoot(): [Hash](_hash_.hash.md) - -*Defined in [Header.ts:61](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L61)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [Header.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L66)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## parentHash - -getparentHash(): [Hash](_hash_.hash.md) - -*Defined in [Header.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L72)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## stateRoot - -getstateRoot(): [Hash](_hash_.hash.md) - -*Defined in [Header.ts:76](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L76)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md deleted file mode 100644 index d2cbcb2ab823..000000000000 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ KeyValue** - -# Constructors - - - -## constructor - -⊕ **new KeyValue**(value?: *`KeyValueValue`*): [KeyValue](_keyvalue_.keyvalue.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [KeyValue.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `KeyValueValue` | - -**Returns:** [KeyValue](_keyvalue_.keyvalue.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## key - -getkey(): [StorageKey](_storagekey_.storagekey.md) - -*Defined in [KeyValue.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L30)* - -**Returns:** [StorageKey](_storagekey_.storagekey.md) - -___ - - -## value - -getvalue(): [StorageData](_storagedata_.storagedata.md) - -*Defined in [KeyValue.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L34)* - -**Returns:** [StorageData](_storagedata_.storagedata.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md deleted file mode 100644 index 1df698cc5f69..000000000000 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ /dev/null @@ -1,315 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ KeyValueOption** - -# Constructors - - - -## constructor - -⊕ **new KeyValueOption**(value?: *[KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue)*): [KeyValueOption](_keyvalue_.keyvalueoption.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [KeyValue.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue) | - -**Returns:** [KeyValueOption](_keyvalue_.keyvalueoption.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## key - -getkey(): [StorageKey](_storagekey_.storagekey.md) - -*Defined in [KeyValue.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L55)* - -**Returns:** [StorageKey](_storagekey_.storagekey.md) - -___ - - -## value - -getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> - -*Defined in [KeyValue.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L59)* - -**Returns:** [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)* - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L34)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L46)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Tuple.ts#L24)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.callmetadata.md b/docs/types/classes/_metadata_.callmetadata.md deleted file mode 100644 index ba681a0ed4e1..000000000000 --- a/docs/types/classes/_metadata_.callmetadata.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ CallMetadata** - -# Constructors - - - -## constructor - -⊕ **new CallMetadata**(value?: *`any`*): [CallMetadata](_metadata_.callmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:123](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L123)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [CallMetadata](_metadata_.callmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## functions - -getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> - -*Defined in [Metadata.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L131)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)> - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:135](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L135)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.eventmetadata.md b/docs/types/classes/_metadata_.eventmetadata.md deleted file mode 100644 index cea1752ea780..000000000000 --- a/docs/types/classes/_metadata_.eventmetadata.md +++ /dev/null @@ -1,324 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ EventMetadata** - -# Constructors - - - -## constructor - -⊕ **new EventMetadata**(value?: *`any`*): [EventMetadata](_metadata_.eventmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:23](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L23)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [EventMetadata](_metadata_.eventmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## arguments - -getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> - -*Defined in [Metadata.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L32)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> - -___ - - -## documentation - -getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -*Defined in [Metadata.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L36)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L40)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.functionargumentmetadata.md b/docs/types/classes/_metadata_.functionargumentmetadata.md deleted file mode 100644 index 0eaad689100d..000000000000 --- a/docs/types/classes/_metadata_.functionargumentmetadata.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ FunctionArgumentMetadata** - -# Constructors - - - -## constructor - -⊕ **new FunctionArgumentMetadata**(value?: *`any`*): [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L79)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L87)* - -**Returns:** [Text](_text_.text.md) - -___ - - -## type - -gettype(): [Type](_type_.type.md) - -*Defined in [Metadata.ts:91](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L91)* - -**Returns:** [Type](_type_.type.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.functionmetadata.md b/docs/types/classes/_metadata_.functionmetadata.md deleted file mode 100644 index e5cf9bcb2fed..000000000000 --- a/docs/types/classes/_metadata_.functionmetadata.md +++ /dev/null @@ -1,335 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ FunctionMetadata** - -# Constructors - - - -## constructor - -⊕ **new FunctionMetadata**(value?: *`any`*): [FunctionMetadata](_metadata_.functionmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:96](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L96)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## arguments - -getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> - -*Defined in [Metadata.ts:106](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L106)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> - -___ - - -## documentation - -getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -*Defined in [Metadata.ts:110](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L110)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -___ - - -## id - -getid(): [U16](_u16_.u16.md) - -*Defined in [Metadata.ts:114](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L114)* - -**Returns:** [U16](_u16_.u16.md) - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:118](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L118)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.modulemetadata.md b/docs/types/classes/_metadata_.modulemetadata.md deleted file mode 100644 index 13b7f1130f0e..000000000000 --- a/docs/types/classes/_metadata_.modulemetadata.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ModuleMetadata** - -# Constructors - - - -## constructor - -⊕ **new ModuleMetadata**(value?: *`any`*): [ModuleMetadata](_metadata_.modulemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L140)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## call - -getcall(): [CallMetadata](_metadata_.callmetadata.md) - -*Defined in [Metadata.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L148)* - -**Returns:** [CallMetadata](_metadata_.callmetadata.md) - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:152](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L152)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.outereventmetadata.md b/docs/types/classes/_metadata_.outereventmetadata.md deleted file mode 100644 index 974d9ea5c13e..000000000000 --- a/docs/types/classes/_metadata_.outereventmetadata.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ OuterEventMetadata** - -# Constructors - - - -## constructor - -⊕ **new OuterEventMetadata**(value?: *`any`*): [OuterEventMetadata](_metadata_.outereventmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L62)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterEventMetadata](_metadata_.outereventmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## events - -getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> - -*Defined in [Metadata.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L70)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L74)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.outereventmetadataevent.md b/docs/types/classes/_metadata_.outereventmetadataevent.md deleted file mode 100644 index 206c6f2f47de..000000000000 --- a/docs/types/classes/_metadata_.outereventmetadataevent.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ OuterEventMetadataEvent** - -# Constructors - - - -## constructor - -⊕ **new OuterEventMetadataEvent**(value?: *`any`*): [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## events - -getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> - -*Defined in [Metadata.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L53)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)> - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L57)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.runtimemetadata.md b/docs/types/classes/_metadata_.runtimemetadata.md deleted file mode 100644 index 45837560d584..000000000000 --- a/docs/types/classes/_metadata_.runtimemetadata.md +++ /dev/null @@ -1,320 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RuntimeMetadata** - -# Constructors - - - -## constructor - -⊕ **new RuntimeMetadata**(value?: *`any`*): [RuntimeMetadata](_metadata_.runtimemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:280](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L280)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## events - -getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> - -*Defined in [Metadata.ts:303](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L303)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)> - -___ - - -## modules - -getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> - -*Defined in [Metadata.ts:307](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L307)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)> - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: * `Uint8Array` | `string` | `Array`<`number`>*): [RuntimeMetadata](_metadata_.runtimemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L290)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | `string` | `Array`<`number`>| - -**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## getUniqTypes - -▸ **getUniqTypes**(): `Array`<`string`> - -*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L312)* - -**Returns:** `Array`<`string`> - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L299)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.runtimemodulemetadata.md b/docs/types/classes/_metadata_.runtimemodulemetadata.md deleted file mode 100644 index d2303f023766..000000000000 --- a/docs/types/classes/_metadata_.runtimemodulemetadata.md +++ /dev/null @@ -1,324 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RuntimeModuleMetadata** - -# Constructors - - - -## constructor - -⊕ **new RuntimeModuleMetadata**(value?: *`any`*): [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:258](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L258)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## module - -getmodule(): [ModuleMetadata](_metadata_.modulemetadata.md) - -*Defined in [Metadata.ts:267](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L267)* - -**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md) - -___ - - -## prefix - -getprefix(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:271](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L271)* - -**Returns:** [Text](_text_.text.md) - -___ - - -## storage - -getstorage(): [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` - -*Defined in [Metadata.ts:275](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L275)* - -**Returns:** [StorageMetadata](_metadata_.storagemetadata.md) | `undefined` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.storagefunctionmetadata.md b/docs/types/classes/_metadata_.storagefunctionmetadata.md deleted file mode 100644 index cc4242e633b4..000000000000 --- a/docs/types/classes/_metadata_.storagefunctionmetadata.md +++ /dev/null @@ -1,335 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageFunctionMetadata** - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionMetadata**(value?: *`StorageFunctionMetadataValue`*): [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:214](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L214)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `StorageFunctionMetadataValue` | - -**Returns:** [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## documentation - -getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -*Defined in [Metadata.ts:224](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L224)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> - -___ - - -## modifier - -getmodifier(): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) - -*Defined in [Metadata.ts:232](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L232)* - -**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) - -___ - - -## name - -getname(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:228](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L228)* - -**Returns:** [Text](_text_.text.md) - -___ - - -## type - -gettype(): [StorageFunctionType](_metadata_.storagefunctiontype.md) - -*Defined in [Metadata.ts:236](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L236)* - -**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.storagefunctionmodifier.md b/docs/types/classes/_metadata_.storagefunctionmodifier.md deleted file mode 100644 index 213ba98f0924..000000000000 --- a/docs/types/classes/_metadata_.storagefunctionmodifier.md +++ /dev/null @@ -1,168 +0,0 @@ - - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ StorageFunctionModifier** - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionModifier**(value?: *`any`*): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [Metadata.ts:157](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L157)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`number`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L31)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L35)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L49)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L57)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L61)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_metadata_.storagefunctiontype.md b/docs/types/classes/_metadata_.storagefunctiontype.md deleted file mode 100644 index c60d59de40da..000000000000 --- a/docs/types/classes/_metadata_.storagefunctiontype.md +++ /dev/null @@ -1,232 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> - -**↳ StorageFunctionType** - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionType**(index?: * `undefined` | `number`*, value?: *`any`*): [StorageFunctionType](_metadata_.storagefunctiontype.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [Metadata.ts:180](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L180)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | `undefined` | `number`| -| `Optional` value | `any` | - -**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md) - -___ - -# Properties - - - -## raw - -**● raw**: *[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[Type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L40)* - -**Returns:** `string` - -___ - - -## asMap - -getasMap(): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) - -*Defined in [Metadata.ts:192](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L192)* - -**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) - -___ - - -## asType - -getasType(): [Type](_type_.type.md) - -*Defined in [Metadata.ts:196](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L196)* - -**Returns:** [Type](_type_.type.md) - -___ - - -## isMap - -getisMap(): `boolean` - -*Defined in [Metadata.ts:188](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L188)* - -**Returns:** `boolean` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[byteLength](_codec_enumtype_.enumtype.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L44)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>> - -*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[fromU8a](_codec_enumtype_.enumtype.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> - -___ - - -## setValue - -▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> | `number`*, value?: *`any`*): `void` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* - -*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L55)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) | [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> | `number`| -| `Optional` value | `any` | - -**Returns:** `void` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L72)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L76)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [Metadata.ts:200](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L200)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_metadata_.storagefunctiontype_map.md b/docs/types/classes/_metadata_.storagefunctiontype_map.md deleted file mode 100644 index 3f69d70d2305..000000000000 --- a/docs/types/classes/_metadata_.storagefunctiontype_map.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageFunctionType$Map** - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionType$Map**(value?: *`any`*): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:163](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L163)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## key - -getkey(): [Type](_type_.type.md) - -*Defined in [Metadata.ts:171](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L171)* - -**Returns:** [Type](_type_.type.md) - -___ - - -## value - -getvalue(): [Type](_type_.type.md) - -*Defined in [Metadata.ts:175](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L175)* - -**Returns:** [Type](_type_.type.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_metadata_.storagemetadata.md b/docs/types/classes/_metadata_.storagemetadata.md deleted file mode 100644 index 57da77928582..000000000000 --- a/docs/types/classes/_metadata_.storagemetadata.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageMetadata** - -# Constructors - - - -## constructor - -⊕ **new StorageMetadata**(value?: *`any`*): [StorageMetadata](_metadata_.storagemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L241)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [StorageMetadata](_metadata_.storagemetadata.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## functions - -getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> - -*Defined in [Metadata.ts:249](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L249)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)> - -___ - - -## prefix - -getprefix(): [Text](_text_.text.md) - -*Defined in [Metadata.ts:253](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Metadata.ts#L253)* - -**Returns:** [Text](_text_.text.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md deleted file mode 100644 index 315b435d9163..000000000000 --- a/docs/types/classes/_method_.method.md +++ /dev/null @@ -1,356 +0,0 @@ - - -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). - -# Hierarchy - -↳ [MethodIndex](_methodindex_.methodindex.md) - -**↳ Method** - -# Constructors - - - -## constructor - -⊕ **new Method**(index: * [Method](_method_.method.md) | [AnyU8a](../modules/_types_d_.md#anyu8a)*, meta: *[FunctionMetadata](_metadata_.functionmetadata.md)*, args: *`Array`<`any`>*): [Method](_method_.method.md) - -*Overrides [MethodIndex](_methodindex_.methodindex.md).[constructor](_methodindex_.methodindex.md#constructor)* - -*Defined in [Method.ts:21](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L21)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | [Method](_method_.method.md) | [AnyU8a](../modules/_types_d_.md#anyu8a)| -| meta | [FunctionMetadata](_metadata_.functionmetadata.md) | -| args | `Array`<`any`> | - -**Returns:** [Method](_method_.method.md) - -___ - -# Properties - - - -## `` _args - -**● _args**: *`Array`<[Base](_codec_base_.base.md)>* - -*Defined in [Method.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L19)* - -___ - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## `` _data - -**● _data**: *`Uint8Array`* - -*Defined in [Method.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L20)* - -___ - - -## `` _meta - -**● _meta**: *[FunctionMetadata](_metadata_.functionmetadata.md)* - -*Defined in [Method.ts:21](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L21)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## args - -getargs(): `Array`<`any`> - -*Defined in [Method.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L71)* - -**Returns:** `Array`<`any`> - -___ - - -## callIndex - -getcallIndex(): `Uint8Array` - -*Inherited from [MethodIndex](_methodindex_.methodindex.md).[callIndex](_methodindex_.methodindex.md#callindex)* - -*Defined in [MethodIndex.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L14)* - -**Returns:** `Uint8Array` - -___ - - -## data - -getdata(): `Uint8Array` - -*Defined in [Method.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L75)* - -**Returns:** `Uint8Array` - -___ - - -## index - -getindex(): `Uint8Array` - -*Defined in [Method.ts:79](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L79)* - -**Returns:** `Uint8Array` - -___ - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - - -## meta - -getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) - -*Defined in [Method.ts:83](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L83)* - -**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) - -___ - - -## methodIndex - -getmethodIndex(): `number` - -*Inherited from [MethodIndex](_methodindex_.methodindex.md).[methodIndex](_methodindex_.methodindex.md#methodindex)* - -*Defined in [MethodIndex.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L18)* - -**Returns:** `number` - -___ - - -## sectionIndex - -getsectionIndex(): `number` - -*Inherited from [MethodIndex](_methodindex_.methodindex.md).[sectionIndex](_methodindex_.methodindex.md#sectionindex)* - -*Defined in [MethodIndex.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L22)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Defined in [Method.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L67)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Method](_method_.method.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Defined in [Method.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Method](_method_.method.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [Method.ts:95](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L95)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(meta: *[FunctionMetadata](_metadata_.functionmetadata.md)*, data: *`Uint8Array`*): `Array`<[Base](_codec_base_.base.md)> - -*Defined in [Method.ts:37](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L37)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| meta | [FunctionMetadata](_metadata_.functionmetadata.md) | -| data | `Uint8Array` | - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` encode - -▸ **encode**(meta: *[FunctionMetadata](_metadata_.functionmetadata.md)*, args: *`Array`<`any`>*): `Uint8Array` - -*Defined in [Method.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L49)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| meta | [FunctionMetadata](_metadata_.functionmetadata.md) | -| args | `Array`<`any`> | - -**Returns:** `Uint8Array` - -___ - - -## `` filterOrigin - -▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> - -*Defined in [Method.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Method.ts#L58)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` meta | [FunctionMetadata](_metadata_.functionmetadata.md) | - -**Returns:** `Array`<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)> - -___ - diff --git a/docs/types/classes/_methodindex_.methodindex.md b/docs/types/classes/_methodindex_.methodindex.md deleted file mode 100644 index 2f4fbb0da8c9..000000000000 --- a/docs/types/classes/_methodindex_.methodindex.md +++ /dev/null @@ -1,230 +0,0 @@ - - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ MethodIndex** - -↳ [Method](_method_.method.md) - -# Constructors - - - -## constructor - -⊕ **new MethodIndex**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [MethodIndex](_methodindex_.methodindex.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [MethodIndex.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [MethodIndex](_methodindex_.methodindex.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## callIndex - -getcallIndex(): `Uint8Array` - -*Defined in [MethodIndex.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L14)* - -**Returns:** `Uint8Array` - -___ - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - - -## methodIndex - -getmethodIndex(): `number` - -*Defined in [MethodIndex.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L18)* - -**Returns:** `number` - -___ - - -## sectionIndex - -getsectionIndex(): `number` - -*Defined in [MethodIndex.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MethodIndex.ts#L22)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md deleted file mode 100644 index 1a80ebea66a6..000000000000 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ /dev/null @@ -1,328 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ BftAtReport** - -↳ [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) - -↳ [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) - -# Constructors - - - -## constructor - -⊕ **new BftAtReport**(value?: *`BftAtReportValue`*): [BftAtReport](_misbehaviorreport_.bftatreport.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` | - -**Returns:** [BftAtReport](_misbehaviorreport_.bftatreport.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## a - -geta(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L36)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## b - -getb(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L40)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## round - -getround(): [U32](_u32_.u32.md) - -*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L44)* - -**Returns:** [U32](_u32_.u32.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md deleted file mode 100644 index 34849534c5ad..000000000000 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ /dev/null @@ -1,332 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) - -**↳ BftDoubleCommit** - -# Constructors - - - -## constructor - -⊕ **new BftDoubleCommit**(value?: *`BftAtReportValue`*): [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[constructor](_misbehaviorreport_.bftatreport.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` | - -**Returns:** [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## a - -geta(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* - -*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L36)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## b - -getb(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* - -*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L40)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## round - -getround(): [U32](_u32_.u32.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* - -*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L44)* - -**Returns:** [U32](_u32_.u32.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md deleted file mode 100644 index 1d75bf4b5bf9..000000000000 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ /dev/null @@ -1,332 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [BftAtReport](_misbehaviorreport_.bftatreport.md) - -**↳ BftDoublePrepare** - -# Constructors - - - -## constructor - -⊕ **new BftDoublePrepare**(value?: *`BftAtReportValue`*): [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[constructor](_misbehaviorreport_.bftatreport.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` | - -**Returns:** [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## a - -geta(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* - -*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L36)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## b - -getb(): [BftHashSignature](_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* - -*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L40)* - -**Returns:** [BftHashSignature](_bft_.bfthashsignature.md) - -___ - - -## round - -getround(): [U32](_u32_.u32.md) - -*Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* - -*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L44)* - -**Returns:** [U32](_u32_.u32.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md deleted file mode 100644 index e2ca8f4525d7..000000000000 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md +++ /dev/null @@ -1,201 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> - -**↳ MisbehaviorKind** - -# Constructors - - - -## constructor - -⊕ **new MisbehaviorKind**(index?: *`number`*, value?: *`BftAtReportValue`*): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [MisbehaviorReport.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L57)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` index | `number` | 17 | -| `Optional` value | `BftAtReportValue` | - | - -**Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) - -___ - -# Properties - - - -## raw - -**● raw**: *[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[Type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L40)* - -**Returns:** `string` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[byteLength](_codec_enumtype_.enumtype.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L44)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>> - -*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)>> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[fromU8a](_codec_enumtype_.enumtype.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> - -___ - - -## setValue - -▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> | `number`*, value?: *`any`*): `void` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)* - -*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L55)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)< [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) | [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)> | `number`| -| `Optional` value | `any` | - -**Returns:** `void` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L72)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L76)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/EnumType.ts#L80)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md deleted file mode 100644 index ba245c695c84..000000000000 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ /dev/null @@ -1,335 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MisbehaviorReport** - -# Constructors - - - -## constructor - -⊕ **new MisbehaviorReport**(value?: *`MisbehaviorReportValue`*): [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [MisbehaviorReport.ts:72](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L72)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `MisbehaviorReportValue` | - -**Returns:** [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## misbehavior - -getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) - -*Defined in [MisbehaviorReport.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L82)* - -**Returns:** [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) - -___ - - -## parentHash - -getparentHash(): [Hash](_hash_.hash.md) - -*Defined in [MisbehaviorReport.ts:86](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L86)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## parentNumber - -getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) - -*Defined in [MisbehaviorReport.ts:90](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L90)* - -**Returns:** [BlockNumber](_blocknumber_.blocknumber.md) - -___ - - -## target - -gettarget(): [AuthorityId](_authorityid_.authorityid.md) - -*Defined in [MisbehaviorReport.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/MisbehaviorReport.ts#L94)* - -**Returns:** [AuthorityId](_authorityid_.authorityid.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md deleted file mode 100644 index 9bb188697771..000000000000 --- a/docs/types/classes/_moment_.moment.md +++ /dev/null @@ -1,193 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`Date`> - -**↳ Moment** - -# Constructors - - - -## constructor - -⊕ **new Moment**(value?: * `Uint8Array` | [Moment](_moment_.moment.md) | `Date` | `BN` | `number`*): [Moment](_moment_.moment.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [Moment.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L19)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | `Uint8Array` | [Moment](_moment_.moment.md) | `Date` | `BN` | `number`| 0 | - -**Returns:** [Moment](_moment_.moment.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Date`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [Moment.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L40)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Moment](_moment_.moment.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [Moment.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Moment](_moment_.moment.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Moment](_moment_.moment.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [Moment.ts:50](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L50)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Moment](_moment_.moment.md) - -___ - - -## getTime - -▸ **getTime**(): `number` - -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L58)* - -**Returns:** `number` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Defined in [Moment.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L74)* - -**Returns:** `BN` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [Moment.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L62)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [Moment.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L78)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [Moment.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L70)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [Moment.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L66)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: * `Uint8Array` | [Moment](_moment_.moment.md) | `number` | `BN`*): `Date` - -*Defined in [Moment.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Moment.ts#L28)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | `Uint8Array` | [Moment](_moment_.moment.md) | `number` | `BN`| - -**Returns:** `Date` - -___ - diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md deleted file mode 100644 index b50928f3a6fb..000000000000 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ /dev/null @@ -1,168 +0,0 @@ - - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ NewAccountOutcome** - -# Constructors - - - -## constructor - -⊕ **new NewAccountOutcome**(index?: * `undefined` | `number`*): [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [NewAccountOutcome.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/NewAccountOutcome.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | `undefined` | `number`| - -**Returns:** [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`number`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L31)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L35)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L49)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L57)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L61)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_nonce_.index.md b/docs/types/classes/_nonce_.index.md deleted file mode 100644 index 70ef15349bc5..000000000000 --- a/docs/types/classes/_nonce_.index.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U64](_u64_.u64.md) - -**↳ Index** - -# Constructors - - - -## constructor - -⊕ **new Index**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Index](_nonce_.index.md) - -*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U64.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [Index](_nonce_.index.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md deleted file mode 100644 index 6b7869318fc2..000000000000 --- a/docs/types/classes/_origin_.origin.md +++ /dev/null @@ -1,139 +0,0 @@ - - -# Type parameters -#### T -# Hierarchy - - [Base](_codec_base_.base.md) - -**↳ Origin** - -# Constructors - - - -## constructor - -⊕ **new Origin**(): [Origin](_origin_.origin.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [Origin.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Origin.ts#L8)* - -**Returns:** [Origin](_origin_.origin.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L25)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`> - -*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L29)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Base](_codec_base_.base.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`> - -*Inherited from [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Base](_codec_base_.base.md)<`T`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L37)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L41)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_parachainid_.parachainid.md b/docs/types/classes/_parachainid_.parachainid.md deleted file mode 100644 index a79369f7d4eb..000000000000 --- a/docs/types/classes/_parachainid_.parachainid.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U64](_u64_.u64.md) - -**↳ ParachainId** - -# Constructors - - - -## constructor - -⊕ **new ParachainId**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ParachainId](_parachainid_.parachainid.md) - -*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U64.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [ParachainId](_parachainid_.parachainid.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md deleted file mode 100644 index cf2218a2a4f2..000000000000 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ /dev/null @@ -1,351 +0,0 @@ - - -# Type parameters -#### T : [Base](_codec_base_.base.md) -# Hierarchy - -↳ [Extrinsics](_extrinsics_.extrinsics.md) - -**↳ PendingExtrinsics** - -# Constructors - - - -## constructor - -⊕ **new PendingExtrinsics**(Type: *`object`*, value?: *`Array`<`any`>*): [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Vector.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L18)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| Type | `object` | - | -| `Default value` value | `Array`<`any`> | [] as Array<any> | - -**Returns:** [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Array`<`T`>* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L40)* - -**Returns:** `string` - -___ - - -## length - -getlength(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Defined in [codec/Vector.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L44)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[byteLength](_codec_vector_.vector.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L48)* - -**Returns:** `number` - -___ - - -## filter - -▸ **filter**(fn: *`function`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Defined in [codec/Vector.ts:54](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L54)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**(fn: *`function`*): `T` | `undefined` - -*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)* - -*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L58)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `T` | `undefined` - -___ - - -## forEach - -▸ **forEach**(fn: *`function`*): `any` - -*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)* - -*Defined in [codec/Vector.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L62)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `any` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[fromJSON](_codec_vector_.vector.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L66)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[fromU8a](_codec_vector_.vector.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L74)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Vector](_codec_vector_.vector.md)<`T`> - -___ - - -## get - -▸ **get**(index: *`number`*): `T` - -*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L90)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `T` - -___ - - -## map - -▸ **map**<`O`>(fn: *`function`*): `Array`<`O`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L94)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | - -**Returns:** `Array`<`O`> - -___ - - -## push - -▸ **push**(item: *`T`*): `void` - -*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)* - -*Defined in [codec/Vector.ts:98](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L98)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| item | `T` | - -**Returns:** `void` - -___ - - -## reduce - -▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O` - -*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)* - -*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L102)* - -**Type parameters:** - -#### O -**Parameters:** - -| Param | Type | -| ------ | ------ | -| fn | `function` | -| initial | `O` | - -**Returns:** `O` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L106)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L125)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Vector.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`O`>(Type: *`object`*): `object` - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### O : [Base](_codec_base_.base.md) -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Type | `object` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md deleted file mode 100644 index b43c28c10e8f..000000000000 --- a/docs/types/classes/_perbill_.perbill.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ Perbill** - -# Constructors - - - -## constructor - -⊕ **new Perbill**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Perbill](_perbill_.perbill.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [Perbill](_perbill_.perbill.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md deleted file mode 100644 index f8bc055a75f0..000000000000 --- a/docs/types/classes/_permill_.permill.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ Permill** - -# Constructors - - - -## constructor - -⊕ **new Permill**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Permill](_permill_.permill.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [Permill](_permill_.permill.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md deleted file mode 100644 index c35e1ed68991..000000000000 --- a/docs/types/classes/_propindex_.propindex.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ PropIndex** - -# Constructors - - - -## constructor - -⊕ **new PropIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [PropIndex](_propindex_.propindex.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [PropIndex](_propindex_.propindex.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md deleted file mode 100644 index bd825294b503..000000000000 --- a/docs/types/classes/_proposal_.proposal.md +++ /dev/null @@ -1,431 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Extrinsic](_extrinsic_.extrinsic.md) - -**↳ Proposal** - -# Constructors - - - -## constructor - -⊕ **new Proposal**(value?: *`ExtrinsicValue`*): [Proposal](_proposal_.proposal.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[constructor](_extrinsic_.extrinsic.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Extrinsic.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L38)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `ExtrinsicValue` | - -**Returns:** [Proposal](_proposal_.proposal.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## callIndex - -getcallIndex(): `Uint8Array` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[callIndex](_extrinsic_.extrinsic.md#callindex)* - -*Defined in [Extrinsic.ts:47](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L47)* - -**Returns:** `Uint8Array` - -___ - - -## data - -getdata(): `Uint8Array` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[data](_extrinsic_.extrinsic.md#data)* - -*Defined in [Extrinsic.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L51)* - -**Returns:** `Uint8Array` - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[hash](_extrinsic_.extrinsic.md#hash)* - -*Defined in [Extrinsic.ts:56](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L56)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## isSigned - -getisSigned(): `boolean` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[isSigned](_extrinsic_.extrinsic.md#issigned)* - -*Defined in [Extrinsic.ts:62](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L62)* - -**Returns:** `boolean` - -___ - - -## length - -getlength(): `number` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[length](_extrinsic_.extrinsic.md#length)* - -*Defined in [Extrinsic.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L66)* - -**Returns:** `number` - -___ - - -## meta - -getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[meta](_extrinsic_.extrinsic.md#meta)* - -*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L70)* - -**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md) - -___ - - -## method - -getmethod(): [Method](_method_.method.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[method](_extrinsic_.extrinsic.md#method)* - -*Defined in [Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L74)* - -**Returns:** [Method](_method_.method.md) - -___ - - -## signature - -getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[signature](_extrinsic_.extrinsic.md#signature)* - -*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L78)* - -**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[byteLength](_extrinsic_.extrinsic.md#bytelength)* - -*Overrides [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Defined in [Extrinsic.ts:82](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L82)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[fromJSON](_extrinsic_.extrinsic.md#fromjson)* - -*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Defined in [Extrinsic.ts:88](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L88)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[fromU8a](_extrinsic_.extrinsic.md#fromu8a)* - -*Overrides [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Defined in [Extrinsic.ts:94](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L94)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## sign - -▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_d_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Extrinsic](_extrinsic_.extrinsic.md) - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[sign](_extrinsic_.extrinsic.md#sign)* - -*Defined in [Extrinsic.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| signerPair | `KeyringPair` | -| nonce | [AnyNumber](../modules/_types_d_.md#anynumber) | -| blockHash | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [Extrinsic](_extrinsic_.extrinsic.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[toHex](_extrinsic_.extrinsic.md#tohex)* - -*Defined in [Extrinsic.ts:119](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L119)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[toJSON](_extrinsic_.extrinsic.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L123)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Extrinsic](_extrinsic_.extrinsic.md).[toU8a](_extrinsic_.extrinsic.md#tou8a)* - -*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [Extrinsic.ts:108](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Extrinsic.ts#L108)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md deleted file mode 100644 index 655907a58194..000000000000 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ ProposalIndex** - -# Constructors - - - -## constructor - -⊕ **new ProposalIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ProposalIndex](_proposalindex_.proposalindex.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [ProposalIndex](_proposalindex_.proposalindex.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md deleted file mode 100644 index 0a578318e0fc..000000000000 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ ReferendumIndex** - -# Constructors - - - -## constructor - -⊕ **new ReferendumIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [ReferendumIndex](_referendumindex_.referendumindex.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [ReferendumIndex](_referendumindex_.referendumindex.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md deleted file mode 100644 index c0967bf08cfb..000000000000 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ /dev/null @@ -1,357 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RuntimeVersion** - -# Constructors - - - -## constructor - -⊕ **new RuntimeVersion**(value?: *`RuntimeVersionValue`*): [RuntimeVersion](_runtimeversion_.runtimeversion.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [RuntimeVersion.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L51)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `RuntimeVersionValue` | - -**Returns:** [RuntimeVersion](_runtimeversion_.runtimeversion.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## apis - -getapis(): [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> - -*Defined in [RuntimeVersion.ts:69](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L69)* - -**Returns:** [Vector](_codec_vector_.vector.md)<`RuntimeVersionApi`> - -___ - - -## authoringVersion - -getauthoringVersion(): [U32](_u32_.u32.md) - -*Defined in [RuntimeVersion.ts:73](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L73)* - -**Returns:** [U32](_u32_.u32.md) - -___ - - -## implName - -getimplName(): [Text](_text_.text.md) - -*Defined in [RuntimeVersion.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L77)* - -**Returns:** [Text](_text_.text.md) - -___ - - -## implVersion - -getimplVersion(): [U32](_u32_.u32.md) - -*Defined in [RuntimeVersion.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L81)* - -**Returns:** [U32](_u32_.u32.md) - -___ - - -## specName - -getspecName(): [Text](_text_.text.md) - -*Defined in [RuntimeVersion.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L85)* - -**Returns:** [Text](_text_.text.md) - -___ - - -## specVersion - -getspecVersion(): [U32](_u32_.u32.md) - -*Defined in [RuntimeVersion.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/RuntimeVersion.ts#L89)* - -**Returns:** [U32](_u32_.u32.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md deleted file mode 100644 index 839503b0dd85..000000000000 --- a/docs/types/classes/_signature_.signature.md +++ /dev/null @@ -1,197 +0,0 @@ - - -# Hierarchy - -↳ [H512](_h512_.h512.md) - -**↳ Signature** - -# Constructors - - - -## constructor - -⊕ **new Signature**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Signature](_signature_.signature.md) - -*Inherited from [H512](_h512_.h512.md).[constructor](_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/H512.ts#L10)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | - -**Returns:** [Signature](_signature_.signature.md) - -___ - -# Properties - - - -## `` _bitLength - -**● _bitLength**: *`number`* - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)* - -*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L14)* - -___ - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L25)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L32)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8aFixed.ts#L44)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md deleted file mode 100644 index 2036770d8b6c..000000000000 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ /dev/null @@ -1,383 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ SignaturePayload** - -# Constructors - - - -## constructor - -⊕ **new SignaturePayload**(value?: *`SignaturePayloadValue`*): [SignaturePayload](_signaturepayload_.signaturepayload.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [SignaturePayload.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `SignaturePayloadValue` | - -**Returns:** [SignaturePayload](_signaturepayload_.signaturepayload.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## ```` _signature - -**● _signature**: *`Uint8Array`* - -*Defined in [SignaturePayload.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## blockHash - -getblockHash(): [Hash](_hash_.hash.md) - -*Defined in [SignaturePayload.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L42)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - - -## era - -getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -*Defined in [SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L50)* - -**Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md) - -___ - - -## isSigned - -getisSigned(): `boolean` - -*Defined in [SignaturePayload.ts:38](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L38)* - -**Returns:** `boolean` - -___ - - -## method - -getmethod(): [Method](_method_.method.md) - -*Defined in [SignaturePayload.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L46)* - -**Returns:** [Method](_method_.method.md) - -___ - - -## nonce - -getnonce(): `Nonce` - -*Defined in [SignaturePayload.ts:54](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L54)* - -**Returns:** `Nonce` - -___ - - -## signature - -getsignature(): `Uint8Array` - -*Defined in [SignaturePayload.ts:58](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L58)* - -**Returns:** `Uint8Array` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## sign - -▸ **sign**(signerPair: *`KeyringPair`*): `Uint8Array` - -*Defined in [SignaturePayload.ts:66](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignaturePayload.ts#L66)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| signerPair | `KeyringPair` | - -**Returns:** `Uint8Array` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md deleted file mode 100644 index 4e3caadc6676..000000000000 --- a/docs/types/classes/_signedblock_.signedblock.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ SignedBlock** - -# Constructors - - - -## constructor - -⊕ **new SignedBlock**(value?: *`SignedBlockValue`*): [SignedBlock](_signedblock_.signedblock.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [SignedBlock.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignedBlock.ts#L14)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `SignedBlockValue` | - -**Returns:** [SignedBlock](_signedblock_.signedblock.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## block - -getblock(): [Block](_block_.block.md) - -*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignedBlock.ts#L22)* - -**Returns:** [Block](_block_.block.md) - -___ - - -## justification - -getjustification(): [Justification](_bft_.justification.md) - -*Defined in [SignedBlock.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/SignedBlock.ts#L26)* - -**Returns:** [Justification](_bft_.justification.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md deleted file mode 100644 index 169a92dbec08..000000000000 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageChangeSet** - -# Constructors - - - -## constructor - -⊕ **new StorageChangeSet**(value?: *`StorageChangeSetValue`*): [StorageChangeSet](_storagechangeset_.storagechangeset.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [StorageChangeSet.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageChangeSet.ts#L19)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `StorageChangeSetValue` | - -**Returns:** [StorageChangeSet](_storagechangeset_.storagechangeset.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## changes - -getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> - -*Defined in [StorageChangeSet.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageChangeSet.ts#L27)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> - -___ - - -## hash - -gethash(): [Hash](_hash_.hash.md) - -*Defined in [StorageChangeSet.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageChangeSet.ts#L31)* - -**Returns:** [Hash](_hash_.hash.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md deleted file mode 100644 index db7e6028fc76..000000000000 --- a/docs/types/classes/_storagedata_.storagedata.md +++ /dev/null @@ -1,188 +0,0 @@ - - -# Hierarchy - -↳ [Bytes](_bytes_.bytes.md) - -**↳ StorageData** - -# Constructors - - - -## constructor - -⊕ **new StorageData**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [StorageData](_storagedata_.storagedata.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L16)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() | - -**Returns:** [StorageData](_storagedata_.storagedata.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L14)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L18)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) - -*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [Bytes.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Bytes](_bytes_.bytes.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [Bytes.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md deleted file mode 100644 index a2ea661d451c..000000000000 --- a/docs/types/classes/_storagekey_.storagekey.md +++ /dev/null @@ -1,231 +0,0 @@ - - -# Hierarchy - -↳ [Bytes](_bytes_.bytes.md) - -**↳ StorageKey** - -# Constructors - - - -## constructor - -⊕ **new StorageKey**(value: * [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): [StorageKey](_storagekey_.storagekey.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [StorageKey.ts:25](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L25)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| - -**Returns:** [StorageKey](_storagekey_.storagekey.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`Uint8Array`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L14)* - -**Returns:** `number` - -___ - - -## outputType - -getoutputType(): `string` | `null` - -*Defined in [StorageKey.ts:63](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L63)* - -**Returns:** `string` | `null` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)* - -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L18)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md) - -*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)* - -*Defined in [Bytes.ts:22](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Bytes](_bytes_.bytes.md) - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L45)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L49)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/U8a.ts#L57)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [Bytes.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bytes.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` encode - -▸ **encode**(value: * [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` - -*Defined in [StorageKey.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L33)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyU8a](../modules/_types_d_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| - -**Returns:** `Uint8Array` - -___ - - -## `` getType - -▸ **getType**(value: * [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` - -*Defined in [StorageKey.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L49)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]| - -**Returns:** `string` | `null` - -___ - diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md deleted file mode 100644 index 5dd00b58871d..000000000000 --- a/docs/types/classes/_text_.text.md +++ /dev/null @@ -1,159 +0,0 @@ - - -# Hierarchy - - [Base](_codec_base_.base.md)<`string`> - -**↳ Text** - -↳ [Type](_type_.type.md) - -# Constructors - - - -## constructor - -⊕ **new Text**(value?: * [Text](_text_.text.md) | `string`*): [Text](_text_.text.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [Text.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L20)* - -**Parameters:** - -| Param | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Text](_text_.text.md) | `string`| "" | - -**Returns:** [Text](_text_.text.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`string`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Defined in [Text.ts:29](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L29)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [Text.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L33)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Text](_text_.text.md) - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [Text.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Text](_text_.text.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Text](_text_.text.md) - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [Text.ts:37](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L37)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Text](_text_.text.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [Text.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L51)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [Text.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L55)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [Text.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md deleted file mode 100644 index f7febad3b5a9..000000000000 --- a/docs/types/classes/_type_.type.md +++ /dev/null @@ -1,165 +0,0 @@ - - -# Hierarchy - -↳ [Text](_text_.text.md) - -**↳ Type** - -# Constructors - - - -## constructor - -⊕ **new Type**(value?: * [Text](_text_.text.md) | `string`*): [Type](_type_.type.md) - -*Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* - -*Defined in [Type.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Type.ts#L15)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [Text](_text_.text.md) | `string`| - -**Returns:** [Type](_type_.type.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`string`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## length - -getlength(): `number` - -*Overrides [Text](_text_.text.md).[length](_text_.text.md#length)* - -*Defined in [Type.ts:26](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Type.ts#L26)* - -**Returns:** `number` - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Text](_text_.text.md).[byteLength](_text_.text.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [Text.ts:33](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L33)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Type](_type_.type.md) - -*Overrides [Text](_text_.text.md).[fromJSON](_text_.text.md#fromjson)* - -*Defined in [Type.ts:30](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Type.ts#L30)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Type](_type_.type.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Type](_type_.type.md) - -*Overrides [Text](_text_.text.md).[fromU8a](_text_.text.md#fromu8a)* - -*Defined in [Type.ts:36](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Type.ts#L36)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Type](_type_.type.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [Text.ts:51](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L51)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Text](_text_.text.md).[toString](_text_.text.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [Text.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Text.ts#L55)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* - -*Defined in [Type.ts:45](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Type.ts#L45)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md deleted file mode 100644 index 5aa531274ae6..000000000000 --- a/docs/types/classes/_u128_.u128.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U128** - -↳ [Balance](_balance_.balance.md) - -# Constructors - - - -## constructor - -⊕ **new U128**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U128](_u128_.u128.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U128.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U128](_u128_.u128.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md deleted file mode 100644 index 99bebd504837..000000000000 --- a/docs/types/classes/_u16_.u16.md +++ /dev/null @@ -1,397 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U16** - -# Constructors - - - -## constructor - -⊕ **new U16**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U16](_u16_.u16.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U16.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U16.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U16](_u16_.u16.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md deleted file mode 100644 index d134cf7d0914..000000000000 --- a/docs/types/classes/_u256_.u256.md +++ /dev/null @@ -1,397 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U256** - -# Constructors - - - -## constructor - -⊕ **new U256**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U256](_u256_.u256.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U256.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U256.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U256](_u256_.u256.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md deleted file mode 100644 index 7780f05d9c7a..000000000000 --- a/docs/types/classes/_u32_.u32.md +++ /dev/null @@ -1,409 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U32** - -↳ [Permill](_permill_.permill.md) - -↳ [Perbill](_perbill_.perbill.md) - -↳ [PropIndex](_propindex_.propindex.md) - -↳ [ProposalIndex](_proposalindex_.proposalindex.md) - -↳ [ReferendumIndex](_referendumindex_.referendumindex.md) - -↳ [VoteIndex](_voteindex_.voteindex.md) - -# Constructors - - - -## constructor - -⊕ **new U32**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U32](_u32_.u32.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U32](_u32_.u32.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md deleted file mode 100644 index 3fb87adcece0..000000000000 --- a/docs/types/classes/_u64_.u64.md +++ /dev/null @@ -1,405 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U64** - -↳ [Index](_nonce_.index.md) - -↳ [BlockNumber](_blocknumber_.blocknumber.md) - -↳ [Gas](_gas_.gas.md) - -↳ [ParachainId](_parachainid_.parachainid.md) - -# Constructors - - - -## constructor - -⊕ **new U64**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U64](_u64_.u64.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U64.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U64](_u64_.u64.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md deleted file mode 100644 index 990ba20472fd..000000000000 --- a/docs/types/classes/_u8_.u8.md +++ /dev/null @@ -1,397 +0,0 @@ - - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U8** - -# Constructors - - - -## constructor - -⊕ **new U8**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [U8](_u8_.u8.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U8.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U8.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [U8](_u8_.u8.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md deleted file mode 100644 index 2bd8e8bba7b7..000000000000 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ /dev/null @@ -1,313 +0,0 @@ - - -# Type parameters -#### S -#### T -#### V -#### E -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ValidatorPrefs** - -# Constructors - - - -## constructor - -⊕ **new ValidatorPrefs**(value?: *`ValidatorPrefsValue`*): [ValidatorPrefs](_validatorprefs_.validatorprefs.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [ValidatorPrefs.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ValidatorPrefs.ts#L16)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `ValidatorPrefsValue` | - -**Returns:** [ValidatorPrefs](_validatorprefs_.validatorprefs.md) - -___ - -# Properties - - - -## `` _Types - -**● _Types**: *`E`* - -*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)* - -*Defined in [codec/Struct.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L28)* - -___ - - -## `` _jsonMap - -**● _jsonMap**: *`Map`<`keyof S`, `string`>* - -*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)* - -*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L27)* - -___ - - -## raw - -**● raw**: *`T`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Accessors - - - -## Type - -getType(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L77)* - -**Returns:** `E` - -___ - - -## unstakeThreshold - -getunstakeThreshold(): [U32](_u32_.u32.md) - -*Defined in [ValidatorPrefs.ts:24](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ValidatorPrefs.ts#L24)* - -**Returns:** [U32](_u32_.u32.md) - -___ - - -## validatorPayment - -getvalidatorPayment(): [Balance](_balance_.balance.md) - -*Defined in [ValidatorPrefs.ts:28](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/ValidatorPrefs.ts#L28)* - -**Returns:** [Balance](_balance_.balance.md) - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Struct.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L81)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Struct.ts:87](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L87)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Struct.ts:102](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L102)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`> - -___ - - -## get - -▸ **get**(index: *`number`*): [Base](_codec_base_.base.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L112)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - - -## keys - -▸ **keys**(): `Array`<`string`> - -*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)* - -*Defined in [codec/Struct.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L127)* - -**Returns:** `Array`<`string`> - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Struct.ts:116](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L116)* - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L139)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Struct.ts:131](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L131)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `Array`<[Base](_codec_base_.base.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)* - -*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L148)* - -**Returns:** `Array`<[Base](_codec_base_.base.md)> - -___ - - -## `` decode - -▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` | `Array`<`any`>*, isTuple: *`boolean`*): `T` - -*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)* - -*Defined in [codec/Struct.ts:46](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L46)* - -**Type parameters:** - -#### S -#### V -#### T -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | -| value | `V` | `Array`<`any`>| -| isTuple | `boolean` | - -**Returns:** `T` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `object` - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:67](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Struct.ts#L67)* - -**Type parameters:** - -#### S -**Parameters:** - -| Param | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `object` - -___ - diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md deleted file mode 100644 index 37205e7bd945..000000000000 --- a/docs/types/classes/_voteindex_.voteindex.md +++ /dev/null @@ -1,399 +0,0 @@ - - -# Hierarchy - -↳ [U32](_u32_.u32.md) - -**↳ VoteIndex** - -# Constructors - - - -## constructor - -⊕ **new VoteIndex**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [VoteIndex](_voteindex_.voteindex.md) - -*Inherited from [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [U32.ts:9](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/U32.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** [VoteIndex](_voteindex_.voteindex.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`BN`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## add - -▸ **add**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)* - -*Defined in [codec/UInt.ts:99](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L99)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/UInt.ts:55](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L55)* - -**Returns:** `number` - -___ - - -## cmp - -▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)* - -*Defined in [codec/UInt.ts:105](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L105)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `number` - -___ - - -## div - -▸ **div**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)* - -*Defined in [codec/UInt.ts:111](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L111)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/UInt.ts:59](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L59)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md) - -*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/UInt.ts:65](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L65)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - - -## gt - -▸ **gt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)* - -*Defined in [codec/UInt.ts:133](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L133)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)* - -*Defined in [codec/UInt.ts:139](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L139)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)* - -*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L117)* - -**Returns:** `boolean` - -___ - - -## lt - -▸ **lt**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)* - -*Defined in [codec/UInt.ts:121](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L121)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(test: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `boolean` - -*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)* - -*Defined in [codec/UInt.ts:127](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L127)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| test | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `boolean` - -___ - - -## mul - -▸ **mul**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)* - -*Defined in [codec/UInt.ts:145](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L145)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(other: * [UInt](_codec_uint_.uint.md) | `BN` | `number`*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)* - -*Defined in [codec/UInt.ts:151](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L151)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| other | [UInt](_codec_uint_.uint.md) | `BN` | `number`| - -**Returns:** `BN` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)* - -*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L89)* - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L71)* - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/UInt.ts:75](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L75)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)* - -*Defined in [codec/UInt.ts:93](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L93)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L85)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L81)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - - -## `` decode - -▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN` - -*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)* - -*Defined in [codec/UInt.ts:40](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/UInt.ts#L40)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_d_.md#anynumber) | - -**Returns:** `BN` - -___ - diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md deleted file mode 100644 index 0c5db2bfcac8..000000000000 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ /dev/null @@ -1,168 +0,0 @@ - - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ VoteThreshold** - -# Constructors - - - -## constructor - -⊕ **new VoteThreshold**(index?: * `undefined` | `number`*): [VoteThreshold](_votethreshold_.votethreshold.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [VoteThreshold.ts:8](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/VoteThreshold.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` index | `undefined` | `number`| - -**Returns:** [VoteThreshold](_votethreshold_.votethreshold.md) - -___ - -# Properties - - - -## raw - -**● raw**: *`number`* - -*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)* - -*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L19)* - -___ - -# Methods - - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)* - -*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)* - -*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L31)* - -**Returns:** `number` - -___ - - -## fromJSON - -▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)* - -*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)* - -*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L35)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `any` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## fromU8a - -▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md) - -*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)* - -*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)* - -*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L42)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)* - -*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L49)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L57)* - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)* - -*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L61)* - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)* - -*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Enum.ts#L53)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` | `false` | `true`| - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md deleted file mode 100644 index 99c308916bea..000000000000 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ /dev/null @@ -1,42 +0,0 @@ - - -# Index - -### Enumeration members - -* [Plain](_codec_createtype_.typedefinfo.md#plain) -* [Tuple](_codec_createtype_.typedefinfo.md#tuple) -* [Vector](_codec_createtype_.typedefinfo.md#vector) - ---- - -# Enumeration members - - - -## Plain - -**Plain**: - -*Defined in [codec/createType.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L15)* - -___ - - -## Tuple - -**Tuple**: - -*Defined in [codec/createType.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L16)* - -___ - - -## Vector - -**Vector**: - -*Defined in [codec/createType.ts:17](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L17)* - -___ - diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md deleted file mode 100644 index b263f020a9b6..000000000000 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ /dev/null @@ -1,63 +0,0 @@ - - -# Hierarchy - -**StorageFunction** - -# Callable -▸ **__call**(arg?: *`any`*): `Uint8Array` - -*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L14)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` arg | `any` | - -**Returns:** `Uint8Array` - -# Properties - - - -## meta - -**● meta**: *[StorageFunctionMetadata](../classes/_metadata_.storagefunctionmetadata.md)* - -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L16)* - -___ - - -## method - -**● method**: *`string`* - -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L17)* - -___ - - -## section - -**● section**: *`string`* - -*Defined in [StorageKey.ts:18](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L18)* - -___ - - -## toJSON - -**● toJSON**: *`function`* - -*Defined in [StorageKey.ts:19](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/StorageKey.ts#L19)* - -#### Type declaration -▸(): `any` - -**Returns:** `any` - -___ - diff --git a/docs/types/modules/_accountid_.md b/docs/types/modules/_accountid_.md deleted file mode 100644 index 23f545a8a563..000000000000 --- a/docs/types/modules/_accountid_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [AccountId](../classes/_accountid_.accountid.md) - ---- - diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md deleted file mode 100644 index 7a38e9677de6..000000000000 --- a/docs/types/modules/_accountindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [AccountIndex](../classes/_accountindex_.accountindex.md) - ---- - diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md deleted file mode 100644 index a760beba3b8a..000000000000 --- a/docs/types/modules/_address_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Address](../classes/_address_.address.md) - ---- - diff --git a/docs/types/modules/_authorityid_.md b/docs/types/modules/_authorityid_.md deleted file mode 100644 index 2e4c9ac4e9ff..000000000000 --- a/docs/types/modules/_authorityid_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [AuthorityId](../classes/_authorityid_.authorityid.md) - ---- - diff --git a/docs/types/modules/_balance_.md b/docs/types/modules/_balance_.md deleted file mode 100644 index 655f6876e6d4..000000000000 --- a/docs/types/modules/_balance_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Balance](../classes/_balance_.balance.md) - ---- - diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md deleted file mode 100644 index cfee8051294b..000000000000 --- a/docs/types/modules/_bft_.md +++ /dev/null @@ -1,54 +0,0 @@ - - -# Index - -### Classes - -* [BftAuthoritySignature](../classes/_bft_.bftauthoritysignature.md) -* [BftHashSignature](../classes/_bft_.bfthashsignature.md) -* [Justification](../classes/_bft_.justification.md) - -### Type aliases - -* [BftAuthoritySignatureValue](_bft_.md#bftauthoritysignaturevalue) -* [BftHashSignatureValue](_bft_.md#bfthashsignaturevalue) -* [JustificationValue](_bft_.md#justificationvalue) - ---- - -# Type aliases - - - -## BftAuthoritySignatureValue - -**Ƭ BftAuthoritySignatureValue**: *`object`* - -*Defined in [Bft.ts:15](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L15)* - -#### Type declaration - -___ - - -## BftHashSignatureValue - -**Ƭ BftHashSignatureValue**: *`object`* - -*Defined in [Bft.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L39)* - -#### Type declaration - -___ - - -## JustificationValue - -**Ƭ JustificationValue**: *`object`* - -*Defined in [Bft.ts:63](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Bft.ts#L63)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md deleted file mode 100644 index 7b3543828d59..000000000000 --- a/docs/types/modules/_block_.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# Index - -### Classes - -* [Block](../classes/_block_.block.md) - -### Type aliases - -* [BlockValue](_block_.md#blockvalue) - ---- - -# Type aliases - - - -## BlockValue - -**Ƭ BlockValue**: *`object`* - -*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Block.ts#L14)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_blocknumber_.md b/docs/types/modules/_blocknumber_.md deleted file mode 100644 index 078e8735acba..000000000000 --- a/docs/types/modules/_blocknumber_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [BlockNumber](../classes/_blocknumber_.blocknumber.md) - ---- - diff --git a/docs/types/modules/_bool_.md b/docs/types/modules/_bool_.md deleted file mode 100644 index ec0cf1ac87e1..000000000000 --- a/docs/types/modules/_bool_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Bool](../classes/_bool_.bool.md) - ---- - diff --git a/docs/types/modules/_bytes_.md b/docs/types/modules/_bytes_.md deleted file mode 100644 index a77ad2f55c77..000000000000 --- a/docs/types/modules/_bytes_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Bytes](../classes/_bytes_.bytes.md) - ---- - diff --git a/docs/types/modules/_codec_base_.md b/docs/types/modules/_codec_base_.md deleted file mode 100644 index 85bc9244388d..000000000000 --- a/docs/types/modules/_codec_base_.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# Index - -### Classes - -* [Base](../classes/_codec_base_.base.md) - -### Variables - -* [l](_codec_base_.md#l) - ---- - -# Variables - - - -## `` l - -**● l**: *`object`* = logger('codec') - -*Defined in [codec/Base.ts:7](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/Base.ts#L7)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_codec_compact_.md b/docs/types/modules/_codec_compact_.md deleted file mode 100644 index f892d0de3724..000000000000 --- 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_.md b/docs/types/modules/_codec_createtype_.md deleted file mode 100644 index 652505b4f035..000000000000 --- a/docs/types/modules/_codec_createtype_.md +++ /dev/null @@ -1,107 +0,0 @@ - - -# Index - -### Enumerations - -* [TypeDefInfo](../enums/_codec_createtype_.typedefinfo.md) - -### Type aliases - -* [TypeDef](_codec_createtype_.md#typedef) - -### Functions - -* [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:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L20)* - -#### Type declaration - -___ - -# Functions - - - -## createType - -▸ **createType**(type: * [Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Base](../classes/_codec_base_.base.md) - -*Defined in [codec/createType.ts:140](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L140)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | [Text](../classes/_text_.text.md) | `string`| -| `Optional` value | `any` | - -**Returns:** [Base](../classes/_codec_base_.base.md) - -___ - - -## getTypeClass - -▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): `Constructor` - -*Defined in [codec/createType.ts:108](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L108)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| value | [TypeDef](_codec_createtype_.md#typedef) | - -**Returns:** `Constructor` - -___ - - -## getTypeDef - -▸ **getTypeDef**(_type: * [Text](../classes/_text_.text.md) | `string`*): [TypeDef](_codec_createtype_.md#typedef) - -*Defined in [codec/createType.ts:77](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L77)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| _type | [Text](../classes/_text_.text.md) | `string`| - -**Returns:** [TypeDef](_codec_createtype_.md#typedef) - -___ - - -## typeSplit - -▸ **typeSplit**(type: *`string`*): `Array`<`string`> - -*Defined in [codec/createType.ts:27](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/codec/createType.ts#L27)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | - -**Returns:** `Array`<`string`> - -___ - diff --git a/docs/types/modules/_codec_enum_.md b/docs/types/modules/_codec_enum_.md deleted file mode 100644 index 7774e7538230..000000000000 --- 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_.md b/docs/types/modules/_codec_enumtype_.md deleted file mode 100644 index bac2d20e437c..000000000000 --- 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_index_.md b/docs/types/modules/_codec_index_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/types/modules/_codec_index_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_codec_option_.md b/docs/types/modules/_codec_option_.md deleted file mode 100644 index 31e36dbde9b1..000000000000 --- 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_struct_.md b/docs/types/modules/_codec_struct_.md deleted file mode 100644 index 78b6b53bf62d..000000000000 --- 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_.md b/docs/types/modules/_codec_tuple_.md deleted file mode 100644 index 8b6af3e8eeab..000000000000 --- 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_u8a_.md b/docs/types/modules/_codec_u8a_.md deleted file mode 100644 index 6e7b7aa79e2a..000000000000 --- 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_.md b/docs/types/modules/_codec_u8afixed_.md deleted file mode 100644 index ab51c9931934..000000000000 --- 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_.md b/docs/types/modules/_codec_uint_.md deleted file mode 100644 index 4f01dedb970f..000000000000 --- 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_vector_.md b/docs/types/modules/_codec_vector_.md deleted file mode 100644 index 02bb06dd38be..000000000000 --- 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/_extrinsic_.md b/docs/types/modules/_extrinsic_.md deleted file mode 100644 index 59e527585879..000000000000 --- a/docs/types/modules/_extrinsic_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Extrinsic](../classes/_extrinsic_.extrinsic.md) - ---- - diff --git a/docs/types/modules/_extrinsicera_.md b/docs/types/modules/_extrinsicera_.md deleted file mode 100644 index 505144441dc5..000000000000 --- a/docs/types/modules/_extrinsicera_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ExtrinsicEra](../classes/_extrinsicera_.extrinsicera.md) - ---- - diff --git a/docs/types/modules/_extrinsics_.md b/docs/types/modules/_extrinsics_.md deleted file mode 100644 index 7644af2faef5..000000000000 --- a/docs/types/modules/_extrinsics_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Extrinsics](../classes/_extrinsics_.extrinsics.md) - ---- - diff --git a/docs/types/modules/_extrinsicsignature_.md b/docs/types/modules/_extrinsicsignature_.md deleted file mode 100644 index 8579ce6db15c..000000000000 --- a/docs/types/modules/_extrinsicsignature_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ExtrinsicSignature](../classes/_extrinsicsignature_.extrinsicsignature.md) - ---- - diff --git a/docs/types/modules/_gas_.md b/docs/types/modules/_gas_.md deleted file mode 100644 index dba7c651dcc3..000000000000 --- a/docs/types/modules/_gas_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Gas](../classes/_gas_.gas.md) - ---- - diff --git a/docs/types/modules/_h256_.md b/docs/types/modules/_h256_.md deleted file mode 100644 index 8ae1f221a5a1..000000000000 --- a/docs/types/modules/_h256_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [H256](../classes/_h256_.h256.md) - ---- - diff --git a/docs/types/modules/_h512_.md b/docs/types/modules/_h512_.md deleted file mode 100644 index 9b2325ddfe32..000000000000 --- a/docs/types/modules/_h512_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [H512](../classes/_h512_.h512.md) - ---- - diff --git a/docs/types/modules/_hash_.md b/docs/types/modules/_hash_.md deleted file mode 100644 index d5bd9068cd60..000000000000 --- a/docs/types/modules/_hash_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Hash](../classes/_hash_.hash.md) - ---- - diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md deleted file mode 100644 index 02208d26f132..000000000000 --- a/docs/types/modules/_header_.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Index - -### Classes - -* [Digest](../classes/_header_.digest.md) -* [Header](../classes/_header_.header.md) - -### Type aliases - -* [HeaderValue](_header_.md#headervalue) - ---- - -# Type aliases - - - -## HeaderValue - -**Ƭ HeaderValue**: *`object`* - -*Defined in [Header.ts:20](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/Header.ts#L20)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_index_.md b/docs/types/modules/_index_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/types/modules/_index_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md deleted file mode 100644 index 5070b9326170..000000000000 --- a/docs/types/modules/_keyvalue_.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Index - -### Classes - -* [KeyValue](../classes/_keyvalue_.keyvalue.md) -* [KeyValueOption](../classes/_keyvalue_.keyvalueoption.md) - -### Type aliases - -* [KeyValueOptionValue](_keyvalue_.md#keyvalueoptionvalue) - ---- - -# Type aliases - - - -## KeyValueOptionValue - -**Ƭ KeyValueOptionValue**: *`object`* - -*Defined in [KeyValue.ts:39](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/KeyValue.ts#L39)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_metadata_.md b/docs/types/modules/_metadata_.md deleted file mode 100644 index d70ab8bedd0f..000000000000 --- a/docs/types/modules/_metadata_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Index - -### Classes - -* [CallMetadata](../classes/_metadata_.callmetadata.md) -* [EventMetadata](../classes/_metadata_.eventmetadata.md) -* [FunctionArgumentMetadata](../classes/_metadata_.functionargumentmetadata.md) -* [FunctionMetadata](../classes/_metadata_.functionmetadata.md) -* [ModuleMetadata](../classes/_metadata_.modulemetadata.md) -* [OuterEventMetadata](../classes/_metadata_.outereventmetadata.md) -* [OuterEventMetadataEvent](../classes/_metadata_.outereventmetadataevent.md) -* [RuntimeMetadata](../classes/_metadata_.runtimemetadata.md) -* [RuntimeModuleMetadata](../classes/_metadata_.runtimemodulemetadata.md) -* [StorageFunctionMetadata](../classes/_metadata_.storagefunctionmetadata.md) -* [StorageFunctionModifier](../classes/_metadata_.storagefunctionmodifier.md) -* [StorageFunctionType](../classes/_metadata_.storagefunctiontype.md) -* [StorageFunctionType$Map](../classes/_metadata_.storagefunctiontype_map.md) -* [StorageMetadata](../classes/_metadata_.storagemetadata.md) - ---- - diff --git a/docs/types/modules/_metadata_rpc_.md b/docs/types/modules/_metadata_rpc_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/types/modules/_metadata_rpc_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_method_.md b/docs/types/modules/_method_.md deleted file mode 100644 index ca7cf417e5aa..000000000000 --- a/docs/types/modules/_method_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Method](../classes/_method_.method.md) - ---- - diff --git a/docs/types/modules/_methodindex_.md b/docs/types/modules/_methodindex_.md deleted file mode 100644 index 590dddff0ad7..000000000000 --- a/docs/types/modules/_methodindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [MethodIndex](../classes/_methodindex_.methodindex.md) - ---- - diff --git a/docs/types/modules/_misbehaviorreport_.md b/docs/types/modules/_misbehaviorreport_.md deleted file mode 100644 index 5972cb78d7b3..000000000000 --- a/docs/types/modules/_misbehaviorreport_.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# Index - -### Classes - -* [BftAtReport](../classes/_misbehaviorreport_.bftatreport.md) -* [BftDoubleCommit](../classes/_misbehaviorreport_.bftdoublecommit.md) -* [BftDoublePrepare](../classes/_misbehaviorreport_.bftdoubleprepare.md) -* [MisbehaviorKind](../classes/_misbehaviorreport_.misbehaviorkind.md) -* [MisbehaviorReport](../classes/_misbehaviorreport_.misbehaviorreport.md) - ---- - diff --git a/docs/types/modules/_moment_.md b/docs/types/modules/_moment_.md deleted file mode 100644 index a17bec61208b..000000000000 --- a/docs/types/modules/_moment_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Moment](../classes/_moment_.moment.md) - ---- - diff --git a/docs/types/modules/_newaccountoutcome_.md b/docs/types/modules/_newaccountoutcome_.md deleted file mode 100644 index 647bb51cd8ae..000000000000 --- a/docs/types/modules/_newaccountoutcome_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [NewAccountOutcome](../classes/_newaccountoutcome_.newaccountoutcome.md) - ---- - diff --git a/docs/types/modules/_nonce_.md b/docs/types/modules/_nonce_.md deleted file mode 100644 index 729c347a58ee..000000000000 --- a/docs/types/modules/_nonce_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Index](../classes/_nonce_.index.md) - ---- - diff --git a/docs/types/modules/_origin_.md b/docs/types/modules/_origin_.md deleted file mode 100644 index 03197ea91764..000000000000 --- a/docs/types/modules/_origin_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Origin](../classes/_origin_.origin.md) - ---- - diff --git a/docs/types/modules/_parachainid_.md b/docs/types/modules/_parachainid_.md deleted file mode 100644 index 9df7bac4d82c..000000000000 --- a/docs/types/modules/_parachainid_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ParachainId](../classes/_parachainid_.parachainid.md) - ---- - diff --git a/docs/types/modules/_pendingextrinsics_.md b/docs/types/modules/_pendingextrinsics_.md deleted file mode 100644 index 90f8ad413f13..000000000000 --- a/docs/types/modules/_pendingextrinsics_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PendingExtrinsics](../classes/_pendingextrinsics_.pendingextrinsics.md) - ---- - diff --git a/docs/types/modules/_perbill_.md b/docs/types/modules/_perbill_.md deleted file mode 100644 index 0ab615aba51c..000000000000 --- a/docs/types/modules/_perbill_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Perbill](../classes/_perbill_.perbill.md) - ---- - diff --git a/docs/types/modules/_permill_.md b/docs/types/modules/_permill_.md deleted file mode 100644 index 1cc904684758..000000000000 --- a/docs/types/modules/_permill_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Permill](../classes/_permill_.permill.md) - ---- - diff --git a/docs/types/modules/_propindex_.md b/docs/types/modules/_propindex_.md deleted file mode 100644 index 2e4ff4000570..000000000000 --- a/docs/types/modules/_propindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PropIndex](../classes/_propindex_.propindex.md) - ---- - diff --git a/docs/types/modules/_proposal_.md b/docs/types/modules/_proposal_.md deleted file mode 100644 index ac814efb6606..000000000000 --- a/docs/types/modules/_proposal_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Proposal](../classes/_proposal_.proposal.md) - ---- - diff --git a/docs/types/modules/_proposalindex_.md b/docs/types/modules/_proposalindex_.md deleted file mode 100644 index 489e2337b21e..000000000000 --- a/docs/types/modules/_proposalindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ProposalIndex](../classes/_proposalindex_.proposalindex.md) - ---- - diff --git a/docs/types/modules/_referendumindex_.md b/docs/types/modules/_referendumindex_.md deleted file mode 100644 index 4eac20263263..000000000000 --- a/docs/types/modules/_referendumindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ReferendumIndex](../classes/_referendumindex_.referendumindex.md) - ---- - diff --git a/docs/types/modules/_runtimeversion_.md b/docs/types/modules/_runtimeversion_.md deleted file mode 100644 index 0edb4fce77b4..000000000000 --- a/docs/types/modules/_runtimeversion_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [RuntimeVersion](../classes/_runtimeversion_.runtimeversion.md) - ---- - diff --git a/docs/types/modules/_signature_.md b/docs/types/modules/_signature_.md deleted file mode 100644 index 9cf0bfdf4215..000000000000 --- a/docs/types/modules/_signature_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Signature](../classes/_signature_.signature.md) - ---- - diff --git a/docs/types/modules/_signaturepayload_.md b/docs/types/modules/_signaturepayload_.md deleted file mode 100644 index 2494261a90c4..000000000000 --- a/docs/types/modules/_signaturepayload_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SignaturePayload](../classes/_signaturepayload_.signaturepayload.md) - ---- - diff --git a/docs/types/modules/_signedblock_.md b/docs/types/modules/_signedblock_.md deleted file mode 100644 index c4327c3e6b88..000000000000 --- a/docs/types/modules/_signedblock_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SignedBlock](../classes/_signedblock_.signedblock.md) - ---- - diff --git a/docs/types/modules/_storagechangeset_.md b/docs/types/modules/_storagechangeset_.md deleted file mode 100644 index abac8f16c68d..000000000000 --- a/docs/types/modules/_storagechangeset_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [StorageChangeSet](../classes/_storagechangeset_.storagechangeset.md) - ---- - diff --git a/docs/types/modules/_storagedata_.md b/docs/types/modules/_storagedata_.md deleted file mode 100644 index c0301380272e..000000000000 --- a/docs/types/modules/_storagedata_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [StorageData](../classes/_storagedata_.storagedata.md) - ---- - diff --git a/docs/types/modules/_storagekey_.md b/docs/types/modules/_storagekey_.md deleted file mode 100644 index 33cd951f8162..000000000000 --- a/docs/types/modules/_storagekey_.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# Index - -### Classes - -* [StorageKey](../classes/_storagekey_.storagekey.md) - -### Interfaces - -* [StorageFunction](../interfaces/_storagekey_.storagefunction.md) - ---- - diff --git a/docs/types/modules/_text_.md b/docs/types/modules/_text_.md deleted file mode 100644 index c416d877a71b..000000000000 --- a/docs/types/modules/_text_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Text](../classes/_text_.text.md) - ---- - diff --git a/docs/types/modules/_type_.md b/docs/types/modules/_type_.md deleted file mode 100644 index 51be28b9cbae..000000000000 --- a/docs/types/modules/_type_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Type](../classes/_type_.type.md) - ---- - diff --git a/docs/types/modules/_types_d_.md b/docs/types/modules/_types_d_.md deleted file mode 100644 index 1b042cd650e9..000000000000 --- a/docs/types/modules/_types_d_.md +++ /dev/null @@ -1,34 +0,0 @@ - - -# Type aliases - - - -## AnyNumber - -**Ƭ AnyNumber**: * [UInt](../classes/_codec_uint_.uint.md) | `BN` | `Uint8Array` | `number` | `string` -* - -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/types.d.ts#L10)* - -___ - - -## AnyU8a - -**Ƭ AnyU8a**: * [U8a](../classes/_codec_u8a_.u8a.md) | `Uint8Array` | `Array`<`number`> | `string` -* - -*Defined in [types.d.ts:12](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/types.d.ts#L12)* - -___ - - -## CodecTypes - -**Ƭ CodecTypes**: *`keyof "/home/travis/build/polkadot-js/api/packages/types/src/index"`* - -*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/ae54a71/packages/types/src/types.d.ts#L14)* - -___ - diff --git a/docs/types/modules/_u128_.md b/docs/types/modules/_u128_.md deleted file mode 100644 index 68e070352b8e..000000000000 --- a/docs/types/modules/_u128_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U128](../classes/_u128_.u128.md) - ---- - diff --git a/docs/types/modules/_u16_.md b/docs/types/modules/_u16_.md deleted file mode 100644 index 9f0eb81b44da..000000000000 --- a/docs/types/modules/_u16_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U16](../classes/_u16_.u16.md) - ---- - diff --git a/docs/types/modules/_u256_.md b/docs/types/modules/_u256_.md deleted file mode 100644 index 05657bb3b56d..000000000000 --- a/docs/types/modules/_u256_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U256](../classes/_u256_.u256.md) - ---- - diff --git a/docs/types/modules/_u32_.md b/docs/types/modules/_u32_.md deleted file mode 100644 index 3cae2a667531..000000000000 --- a/docs/types/modules/_u32_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U32](../classes/_u32_.u32.md) - ---- - diff --git a/docs/types/modules/_u64_.md b/docs/types/modules/_u64_.md deleted file mode 100644 index ab41aa92aa07..000000000000 --- a/docs/types/modules/_u64_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U64](../classes/_u64_.u64.md) - ---- - diff --git a/docs/types/modules/_u8_.md b/docs/types/modules/_u8_.md deleted file mode 100644 index bb12ebee0c8b..000000000000 --- a/docs/types/modules/_u8_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U8](../classes/_u8_.u8.md) - ---- - diff --git a/docs/types/modules/_validatorprefs_.md b/docs/types/modules/_validatorprefs_.md deleted file mode 100644 index b6ba8ee16d59..000000000000 --- a/docs/types/modules/_validatorprefs_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ValidatorPrefs](../classes/_validatorprefs_.validatorprefs.md) - ---- - diff --git a/docs/types/modules/_voteindex_.md b/docs/types/modules/_voteindex_.md deleted file mode 100644 index 0cc0e0284751..000000000000 --- a/docs/types/modules/_voteindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [VoteIndex](../classes/_voteindex_.voteindex.md) - ---- - diff --git a/docs/types/modules/_votethreshold_.md b/docs/types/modules/_votethreshold_.md deleted file mode 100644 index 6feb56ba9c7d..000000000000 --- a/docs/types/modules/_votethreshold_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [VoteThreshold](../classes/_votethreshold_.votethreshold.md) - ---- - From bc4dc3a21460ff6ff478af56cf5a97b8a417a371 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sat, 6 Oct 2018 16:54:35 +0200 Subject: [PATCH 2/9] Rename api, api-provider & api-rx --- jest.config.js | 4 ++-- packages/api-observable/package.json | 6 +++--- packages/api-observable/src/Base.ts | 2 +- packages/{api => rpc-core}/LICENSE | 2 +- packages/{api => rpc-core}/README.md | 10 +++++----- packages/{api => rpc-core}/package.json | 6 +++--- packages/{api => rpc-core}/src/formatting.spec.js | 2 +- packages/{api => rpc-core}/src/index.spec.js | 2 +- packages/{api => rpc-core}/src/index.ts | 10 +++++----- packages/{api => rpc-core}/src/methodSend.spec.js | 2 +- packages/{api => rpc-core}/src/types.d.ts | 2 +- packages/{api => rpc-core}/test/e2e/basics.test.js | 2 +- packages/{api => rpc-core}/test/e2e/chain.test.js | 2 +- .../{api => rpc-core}/test/e2e/krummelanke.test.js | 2 +- packages/{api => rpc-core}/test/e2e/state.test.js | 2 +- .../{api => rpc-core}/test/e2e/subscribe.test.js | 2 +- .../{api-provider => rpc-core}/test/mockHttp.ts | 2 +- packages/{api-provider => rpc-core}/test/mockWs.ts | 2 +- packages/{api-provider => rpc-provider}/LICENSE | 2 +- packages/{api-provider => rpc-provider}/README.md | 12 ++++++------ .../{api-provider => rpc-provider}/package.json | 4 ++-- .../src/coder/json/decodeResponse.spec.js | 2 +- .../src/coder/json/decodeResponse.ts | 2 +- .../src/coder/json/encodeJson.spec.js | 2 +- .../src/coder/json/encodeJson.ts | 2 +- .../src/coder/json/encodeObject.spec.js | 2 +- .../src/coder/json/encodeObject.ts | 2 +- .../src/coder/json/index.ts | 2 +- .../src/coder/json/types.d.ts | 2 +- .../src/http/index.spec.js | 2 +- .../src/http/index.ts | 6 +++--- .../src/http/polyfill.spec.js | 2 +- .../src/http/polyfill.ts | 2 +- .../src/http/send.spec.js | 2 +- .../src/http/types.d.ts | 2 +- .../{api-provider => rpc-provider}/src/index.ts | 2 +- .../src/mock/index.ts | 2 +- .../src/mock/mocks.ts | 2 +- .../{api-provider => rpc-provider}/src/mock/on.ts | 2 +- .../src/mock/send.ts | 2 +- .../src/mock/state.spec.js | 2 +- .../src/mock/state.ts | 2 +- .../src/mock/subscribe.spec.js | 2 +- .../src/mock/subscribe.ts | 2 +- .../src/mock/types.d.ts | 2 +- .../src/mock/unsubscribe.spec.js | 2 +- .../src/mock/unsubscribe.ts | 2 +- .../{api-provider => rpc-provider}/src/types.d.ts | 2 +- .../src/ws/connect.spec.js | 2 +- .../src/ws/index.spec.js | 2 +- .../{api-provider => rpc-provider}/src/ws/index.ts | 6 +++--- .../src/ws/onError.spec.js | 2 +- .../src/ws/onMessageResult.spec.js | 2 +- .../src/ws/onMessageSubscribe.spec.js | 2 +- .../src/ws/onOpen.spec.js | 2 +- .../src/ws/polyfill.spec.js | 2 +- .../src/ws/polyfill.ts | 2 +- .../src/ws/send.spec.js | 2 +- .../src/ws/state.spec.js | 2 +- .../src/ws/subscribe.spec.js | 2 +- .../src/ws/unsubscribe.spec.js | 2 +- packages/{api => rpc-provider}/test/mockHttp.ts | 2 +- packages/{api => rpc-provider}/test/mockWs.ts | 2 +- packages/{api-rx => rpc-rx}/LICENSE | 2 +- packages/{api-rx => rpc-rx}/README.md | 8 ++++---- packages/{api-rx => rpc-rx}/package.json | 8 ++++---- packages/{api-rx => rpc-rx}/src/cached.spec.js | 4 ++-- packages/{api-rx => rpc-rx}/src/defaults.ts | 2 +- packages/{api-rx => rpc-rx}/src/index.spec.js | 4 ++-- packages/{api-rx => rpc-rx}/src/index.ts | 14 +++++++------- packages/{api-rx => rpc-rx}/src/subject.spec.js | 4 ++-- packages/{api-rx => rpc-rx}/src/types.d.ts | 2 +- .../{api-rx => rpc-rx}/test/e2e/subscribe.test.js | 4 ++-- packages/type-extrinsics/test/e2e/transfer.spec.js | 4 ++-- tsconfig.json | 6 +++--- 75 files changed, 117 insertions(+), 117 deletions(-) rename packages/{api => rpc-core}/LICENSE (92%) rename packages/{api => rpc-core}/README.md (86%) rename packages/{api => rpc-core}/package.json (89%) rename packages/{api => rpc-core}/src/formatting.spec.js (96%) rename packages/{api => rpc-core}/src/index.spec.js (92%) rename packages/{api => rpc-core}/src/index.ts (96%) rename packages/{api => rpc-core}/src/methodSend.spec.js (95%) rename packages/{api => rpc-core}/src/types.d.ts (88%) rename packages/{api => rpc-core}/test/e2e/basics.test.js (93%) rename packages/{api => rpc-core}/test/e2e/chain.test.js (96%) rename packages/{api => rpc-core}/test/e2e/krummelanke.test.js (97%) rename packages/{api => rpc-core}/test/e2e/state.test.js (97%) rename packages/{api => rpc-core}/test/e2e/subscribe.test.js (95%) rename packages/{api-provider => rpc-core}/test/mockHttp.ts (91%) rename packages/{api-provider => rpc-core}/test/mockWs.ts (96%) rename packages/{api-provider => rpc-provider}/LICENSE (91%) rename packages/{api-provider => rpc-provider}/README.md (76%) rename packages/{api-provider => rpc-provider}/package.json (94%) rename packages/{api-provider => rpc-provider}/src/coder/json/decodeResponse.spec.js (94%) rename packages/{api-provider => rpc-provider}/src/coder/json/decodeResponse.ts (95%) rename packages/{api-provider => rpc-provider}/src/coder/json/encodeJson.spec.js (87%) rename packages/{api-provider => rpc-provider}/src/coder/json/encodeJson.ts (85%) rename packages/{api-provider => rpc-provider}/src/coder/json/encodeObject.spec.js (90%) rename packages/{api-provider => rpc-provider}/src/coder/json/encodeObject.ts (86%) rename packages/{api-provider => rpc-provider}/src/coder/json/index.ts (92%) rename packages/{api-provider => rpc-provider}/src/coder/json/types.d.ts (88%) rename packages/{api-provider => rpc-provider}/src/http/index.spec.js (94%) rename packages/{api-provider => rpc-provider}/src/http/index.ts (95%) rename packages/{api-provider => rpc-provider}/src/http/polyfill.spec.js (90%) rename packages/{api-provider => rpc-provider}/src/http/polyfill.ts (77%) rename packages/{api-provider => rpc-provider}/src/http/send.spec.js (94%) rename packages/{api-provider => rpc-provider}/src/http/types.d.ts (82%) rename packages/{api-provider => rpc-provider}/src/index.ts (77%) rename packages/{api-provider => rpc-provider}/src/mock/index.ts (94%) rename packages/{api-provider => rpc-provider}/src/mock/mocks.ts (97%) rename packages/{api-provider => rpc-provider}/src/mock/on.ts (86%) rename packages/{api-provider => rpc-provider}/src/mock/send.ts (86%) rename packages/{api-provider => rpc-provider}/src/mock/state.spec.js (90%) rename packages/{api-provider => rpc-provider}/src/mock/state.ts (95%) rename packages/{api-provider => rpc-provider}/src/mock/subscribe.spec.js (95%) rename packages/{api-provider => rpc-provider}/src/mock/subscribe.ts (92%) rename packages/{api-provider => rpc-provider}/src/mock/types.d.ts (93%) rename packages/{api-provider => rpc-provider}/src/mock/unsubscribe.spec.js (95%) rename packages/{api-provider => rpc-provider}/src/mock/unsubscribe.ts (89%) rename packages/{api-provider => rpc-provider}/src/types.d.ts (95%) rename packages/{api-provider => rpc-provider}/src/ws/connect.spec.js (91%) rename packages/{api-provider => rpc-provider}/src/ws/index.spec.js (90%) rename packages/{api-provider => rpc-provider}/src/ws/index.ts (98%) rename packages/{api-provider => rpc-provider}/src/ws/onError.spec.js (89%) rename packages/{api-provider => rpc-provider}/src/ws/onMessageResult.spec.js (93%) rename packages/{api-provider => rpc-provider}/src/ws/onMessageSubscribe.spec.js (96%) rename packages/{api-provider => rpc-provider}/src/ws/onOpen.spec.js (92%) rename packages/{api-provider => rpc-provider}/src/ws/polyfill.spec.js (90%) rename packages/{api-provider => rpc-provider}/src/ws/polyfill.ts (80%) rename packages/{api-provider => rpc-provider}/src/ws/send.spec.js (96%) rename packages/{api-provider => rpc-provider}/src/ws/state.spec.js (87%) rename packages/{api-provider => rpc-provider}/src/ws/subscribe.spec.js (93%) rename packages/{api-provider => rpc-provider}/src/ws/unsubscribe.spec.js (96%) rename packages/{api => rpc-provider}/test/mockHttp.ts (91%) rename packages/{api => rpc-provider}/test/mockWs.ts (96%) rename packages/{api-rx => rpc-rx}/LICENSE (92%) rename packages/{api-rx => rpc-rx}/README.md (72%) rename packages/{api-rx => rpc-rx}/package.json (85%) rename packages/{api-rx => rpc-rx}/src/cached.spec.js (94%) rename packages/{api-rx => rpc-rx}/src/defaults.ts (75%) rename packages/{api-rx => rpc-rx}/src/index.spec.js (86%) rename packages/{api-rx => rpc-rx}/src/index.ts (92%) rename packages/{api-rx => rpc-rx}/src/subject.spec.js (93%) rename packages/{api-rx => rpc-rx}/src/types.d.ts (91%) rename packages/{api-rx => rpc-rx}/test/e2e/subscribe.test.js (90%) diff --git a/jest.config.js b/jest.config.js index 7f4cb51f082a..78a8588b4a6b 100644 --- a/jest.config.js +++ b/jest.config.js @@ -2,8 +2,8 @@ const config = require('@polkadot/dev/config/jest'); module.exports = Object.assign({}, config, { moduleNameMapper: { - '@polkadot/api-(jsonrpc|observable|provider|rx)(.*)$': '/packages/api-$1/src/$2', - '@polkadot/api(.*)$': '/packages/api/src/$1', + '@polkadot/api-observable(.*)$': '/packages/api-observable/src/$1', + '@polkadot/rpc-(core|provider|rx)(.*)$': '/packages/rpc-$1/src/$2', '@polkadot/extrinsics(.*)$': '/packages/type-extrinsics/src/$1', '@polkadot/jsonrpc(.*)$': '/packages/type-jsonrpc/src/$1', '@polkadot/params(.*)$': '/packages/type-params/src/$1', diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index 7ff43fdfc6fb..021ebeea34d0 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -27,11 +27,11 @@ "bugs": { "url": "https://github.com/polkadot-js/api/issues" }, - "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-rx#readme", + "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api": "^0.30.33", - "@polkadot/api-provider": "^0.30.33", + "@polkadot/rpc-core": "^0.30.33", + "@polkadot/rpc-provider": "^0.30.33", "@polkadot/extrinsics": "^0.30.33", "@polkadot/storage": "^0.30.33", "@types/rx": "^4.1.1", diff --git a/packages/api-observable/src/Base.ts b/packages/api-observable/src/Base.ts index a7b8e1b13045..471ab1bb9eae 100644 --- a/packages/api-observable/src/Base.ts +++ b/packages/api-observable/src/Base.ts @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { RxApiInterface, RxApiInterface$Method, RxApiInterface$Section } from '@polkadot/api-rx/types'; +import { RxApiInterface, RxApiInterface$Method, RxApiInterface$Section } from '@polkadot/rpc-rx/types'; import { RpcMethod } from '@polkadot/jsonrpc/types'; import { EMPTY, Observable, combineLatest, from } from 'rxjs'; diff --git a/packages/api/LICENSE b/packages/rpc-core/LICENSE similarity index 92% rename from packages/api/LICENSE rename to packages/rpc-core/LICENSE index a47c81152df7..fd985c74401c 100644 --- a/packages/api/LICENSE +++ b/packages/rpc-core/LICENSE @@ -1,6 +1,6 @@ ISC License (ISC) -Copyright 2017-2018 @polkadot/api authors & contributors +Copyright 2017-2018 @polkadot/rpc-core authors & contributors Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/packages/api/README.md b/packages/rpc-core/README.md similarity index 86% rename from packages/api/README.md rename to packages/rpc-core/README.md index d7947536e3df..9b10ee3e4022 100644 --- a/packages/api/README.md +++ b/packages/rpc-core/README.md @@ -5,8 +5,8 @@ [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) -[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api) -[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api#info=devDependencies) +[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=package/rpc-core)](https://david-dm.org/polkadot-js/api?path=package/rpc-core) +[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=package/rpc-core)](https://david-dm.org/polkadot-js/api?path=package/rpc-core#info=devDependencies) # @polkadot/api @@ -17,14 +17,14 @@ This library provides a clean wrapper around all the methods exposed by a Polkad Installation - ``` -npm install --save @polkadot/api +npm install --save @polkadot/rpc-core ``` Initialisation - ```js -import Api from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; +import Api from '@polkadot/rpc-core'; +import WsProvider from '@polkadot/rpc-provider/ws'; const provider = new WsProvider('http://127.0.0.1:9944'); const api = new Api(provider); diff --git a/packages/api/package.json b/packages/rpc-core/package.json similarity index 89% rename from packages/api/package.json rename to packages/rpc-core/package.json index d5de2c7adb95..1c539d948ebc 100644 --- a/packages/api/package.json +++ b/packages/rpc-core/package.json @@ -1,5 +1,5 @@ { - "name": "@polkadot/api", + "name": "@polkadot/rpc-core", "version": "0.30.33", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", @@ -27,10 +27,10 @@ "bugs": { "url": "https://github.com/polkadot-js/api/issues" }, - "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", + "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api-provider": "^0.30.33", + "@polkadot/rpc-provider": "^0.30.33", "@polkadot/jsonrpc": "^0.30.33", "@polkadot/util": "^0.30.7" } diff --git a/packages/api/src/formatting.spec.js b/packages/rpc-core/src/formatting.spec.js similarity index 96% rename from packages/api/src/formatting.spec.js rename to packages/rpc-core/src/formatting.spec.js index 299ca8e14aad..7e2896cbf5bd 100644 --- a/packages/api/src/formatting.spec.js +++ b/packages/rpc-core/src/formatting.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api authors & contributors +// Copyright 2017-2018 @polkadot/rpc-core authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/src/index.spec.js b/packages/rpc-core/src/index.spec.js similarity index 92% rename from packages/api/src/index.spec.js rename to packages/rpc-core/src/index.spec.js index 8f489ba343be..d62ed4dc0b94 100644 --- a/packages/api/src/index.spec.js +++ b/packages/rpc-core/src/index.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api authors & contributors +// Copyright 2017-2018 @polkadot/rpc-core authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/src/index.ts b/packages/rpc-core/src/index.ts similarity index 96% rename from packages/api/src/index.ts rename to packages/rpc-core/src/index.ts index 7912a850a2aa..434a24fbd6fd 100644 --- a/packages/api/src/index.ts +++ b/packages/rpc-core/src/index.ts @@ -1,8 +1,8 @@ -// Copyright 2017-2018 @polkadot/api authors & contributors +// Copyright 2017-2018 @polkadot/rpc-core authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { ProviderInterface, ProviderInterface$Callback } from '@polkadot/api-provider/types'; +import { ProviderInterface, ProviderInterface$Callback } from '@polkadot/rpc-provider/types'; import { RpcSection, RpcMethod } from '@polkadot/jsonrpc/types'; import { ApiInterface, ApiInterface$Section, ApiInterface$Section$Method } from './types'; @@ -21,8 +21,8 @@ import isFunction from '@polkadot/util/is/function'; *
                * * ```javascript - * import Api from '@polkadot/api'; - * import WsProvider from '@polkadot/api-provider/ws'; + * import Api from '@polkadot/rpc-core'; + * import WsProvider from '@polkadot/rpc-provider/ws'; * * const provider = new WsProvider('ws://127.0.0.1:9944'); * const api = new Api(provider); @@ -61,7 +61,7 @@ export default class Api implements ApiInterface { *
                * * ```javascript - * import Api from '@polkadot/api'; + * import Api from '@polkadot/rpc-core'; * * Api.signature({ name: 'test_method', params: [ { name: 'dest', type: 'Address' } ], type: 'Address' }); // => test_method (dest: Address): Address * ``` diff --git a/packages/api/src/methodSend.spec.js b/packages/rpc-core/src/methodSend.spec.js similarity index 95% rename from packages/api/src/methodSend.spec.js rename to packages/rpc-core/src/methodSend.spec.js index 239b148b7d04..636679844ac4 100644 --- a/packages/api/src/methodSend.spec.js +++ b/packages/rpc-core/src/methodSend.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api authors & contributors +// Copyright 2017-2018 @polkadot/rpc-core authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/src/types.d.ts b/packages/rpc-core/src/types.d.ts similarity index 88% rename from packages/api/src/types.d.ts rename to packages/rpc-core/src/types.d.ts index c37212d4459b..9466acdb8fce 100644 --- a/packages/api/src/types.d.ts +++ b/packages/rpc-core/src/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api authors & contributors +// Copyright 2017-2018 @polkadot/rpc-core authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/test/e2e/basics.test.js b/packages/rpc-core/test/e2e/basics.test.js similarity index 93% rename from packages/api/test/e2e/basics.test.js rename to packages/rpc-core/test/e2e/basics.test.js index 489894c93781..f05f3dc20fd5 100644 --- a/packages/api/test/e2e/basics.test.js +++ b/packages/rpc-core/test/e2e/basics.test.js @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import Api from '../../src'; diff --git a/packages/api/test/e2e/chain.test.js b/packages/rpc-core/test/e2e/chain.test.js similarity index 96% rename from packages/api/test/e2e/chain.test.js rename to packages/rpc-core/test/e2e/chain.test.js index 026d545bf8a8..5796daac6ccb 100644 --- a/packages/api/test/e2e/chain.test.js +++ b/packages/rpc-core/test/e2e/chain.test.js @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import Api from '../../src'; diff --git a/packages/api/test/e2e/krummelanke.test.js b/packages/rpc-core/test/e2e/krummelanke.test.js similarity index 97% rename from packages/api/test/e2e/krummelanke.test.js rename to packages/rpc-core/test/e2e/krummelanke.test.js index d2bdefc0ba55..d32603bf7770 100644 --- a/packages/api/test/e2e/krummelanke.test.js +++ b/packages/rpc-core/test/e2e/krummelanke.test.js @@ -3,7 +3,7 @@ // of the ISC license. See the LICENSE file for details. import storage from '@polkadot/storage'; -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import Api from '../../src'; diff --git a/packages/api/test/e2e/state.test.js b/packages/rpc-core/test/e2e/state.test.js similarity index 97% rename from packages/api/test/e2e/state.test.js rename to packages/rpc-core/test/e2e/state.test.js index 4041c993b305..95a7e78b3a6a 100644 --- a/packages/api/test/e2e/state.test.js +++ b/packages/rpc-core/test/e2e/state.test.js @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import storage from '@polkadot/storage/static'; import Api from '../../src'; diff --git a/packages/api/test/e2e/subscribe.test.js b/packages/rpc-core/test/e2e/subscribe.test.js similarity index 95% rename from packages/api/test/e2e/subscribe.test.js rename to packages/rpc-core/test/e2e/subscribe.test.js index bea59b4c05bc..26f3ad742d24 100644 --- a/packages/api/test/e2e/subscribe.test.js +++ b/packages/rpc-core/test/e2e/subscribe.test.js @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import storage from '@polkadot/storage/static'; import Api from '../../src'; diff --git a/packages/api-provider/test/mockHttp.ts b/packages/rpc-core/test/mockHttp.ts similarity index 91% rename from packages/api-provider/test/mockHttp.ts rename to packages/rpc-core/test/mockHttp.ts index a994a7b188e9..3738c5753ac4 100644 --- a/packages/api-provider/test/mockHttp.ts +++ b/packages/rpc-core/test/mockHttp.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/test/mockWs.ts b/packages/rpc-core/test/mockWs.ts similarity index 96% rename from packages/api-provider/test/mockWs.ts rename to packages/rpc-core/test/mockWs.ts index bae2b3671844..cda2cff95370 100644 --- a/packages/api-provider/test/mockWs.ts +++ b/packages/rpc-core/test/mockWs.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/LICENSE b/packages/rpc-provider/LICENSE similarity index 91% rename from packages/api-provider/LICENSE rename to packages/rpc-provider/LICENSE index 1fecc4af445c..c0f573695001 100644 --- a/packages/api-provider/LICENSE +++ b/packages/rpc-provider/LICENSE @@ -1,6 +1,6 @@ ISC License (ISC) -Copyright 2017-2018 @polkadot/api-provider authors & contributors +Copyright 2017-2018 @polkadot/rpc-provider authors & contributors Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/packages/api-provider/README.md b/packages/rpc-provider/README.md similarity index 76% rename from packages/api-provider/README.md rename to packages/rpc-provider/README.md index 2e8bc1230340..f5e75975c744 100644 --- a/packages/api-provider/README.md +++ b/packages/rpc-provider/README.md @@ -1,14 +1,14 @@ [![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) -[![npm](https://img.shields.io/npm/v/@polkadot/api-provider.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-provider) +[![npm](https://img.shields.io/npm/v/@polkadot/rpc-provider.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/rpc-provider) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) -[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider) -[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider#info=devDependencies) +[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/rpc-provider)](https://david-dm.org/polkadot-js/api?path=packages/rpc-provider) +[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/rpc-provider)](https://david-dm.org/polkadot-js/api?path=packages/rpc-provider#info=devDependencies) -# @polkadot/api-provider +# @polkadot/rpc-provider Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces. @@ -17,13 +17,13 @@ Generic transport providers to handle the transport of method calls to and from Installation - ``` -npm install --save @polkadot/api-provider +npm install --save @polkadot/rpc-provider ``` Initialisation - ```js -import WsProvider from '@polkadot/api-provider/ws'; +import WsProvider from '@polkadot/rpc-provider/ws'; const provider = new WsProvider('http://127.0.0.1:9944'); const version = await provider.send('client_version', []); diff --git a/packages/api-provider/package.json b/packages/rpc-provider/package.json similarity index 94% rename from packages/api-provider/package.json rename to packages/rpc-provider/package.json index a58af52a8fa5..35db4e40c0b7 100644 --- a/packages/api-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,5 +1,5 @@ { - "name": "@polkadot/api-provider", + "name": "@polkadot/rpc-provider", "version": "0.30.33", "description": "Transport providers for the API", "main": "index.js", @@ -27,7 +27,7 @@ "bugs": { "url": "https://github.com/polkadot-js/api/issues" }, - "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-provider#readme", + "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme", "dependencies": { "@babel/runtime": "^7.0.0", "@polkadot/storage": "^0.30.33", diff --git a/packages/api-provider/src/coder/json/decodeResponse.spec.js b/packages/rpc-provider/src/coder/json/decodeResponse.spec.js similarity index 94% rename from packages/api-provider/src/coder/json/decodeResponse.spec.js rename to packages/rpc-provider/src/coder/json/decodeResponse.spec.js index 0d05a173cfdf..b45d982e008f 100644 --- a/packages/api-provider/src/coder/json/decodeResponse.spec.js +++ b/packages/rpc-provider/src/coder/json/decodeResponse.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/decodeResponse.ts b/packages/rpc-provider/src/coder/json/decodeResponse.ts similarity index 95% rename from packages/api-provider/src/coder/json/decodeResponse.ts rename to packages/rpc-provider/src/coder/json/decodeResponse.ts index 59ccfa05683a..1e2da14c8256 100644 --- a/packages/api-provider/src/coder/json/decodeResponse.ts +++ b/packages/rpc-provider/src/coder/json/decodeResponse.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/encodeJson.spec.js b/packages/rpc-provider/src/coder/json/encodeJson.spec.js similarity index 87% rename from packages/api-provider/src/coder/json/encodeJson.spec.js rename to packages/rpc-provider/src/coder/json/encodeJson.spec.js index 09ec29d06202..36cf337374e9 100644 --- a/packages/api-provider/src/coder/json/encodeJson.spec.js +++ b/packages/rpc-provider/src/coder/json/encodeJson.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/encodeJson.ts b/packages/rpc-provider/src/coder/json/encodeJson.ts similarity index 85% rename from packages/api-provider/src/coder/json/encodeJson.ts rename to packages/rpc-provider/src/coder/json/encodeJson.ts index e1c035e2a150..48de8f82c0a1 100644 --- a/packages/api-provider/src/coder/json/encodeJson.ts +++ b/packages/rpc-provider/src/coder/json/encodeJson.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/encodeObject.spec.js b/packages/rpc-provider/src/coder/json/encodeObject.spec.js similarity index 90% rename from packages/api-provider/src/coder/json/encodeObject.spec.js rename to packages/rpc-provider/src/coder/json/encodeObject.spec.js index 573b054a9498..c1f21d0daa75 100644 --- a/packages/api-provider/src/coder/json/encodeObject.spec.js +++ b/packages/rpc-provider/src/coder/json/encodeObject.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/encodeObject.ts b/packages/rpc-provider/src/coder/json/encodeObject.ts similarity index 86% rename from packages/api-provider/src/coder/json/encodeObject.ts rename to packages/rpc-provider/src/coder/json/encodeObject.ts index e9d470628548..170f6238c3fb 100644 --- a/packages/api-provider/src/coder/json/encodeObject.ts +++ b/packages/rpc-provider/src/coder/json/encodeObject.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/index.ts b/packages/rpc-provider/src/coder/json/index.ts similarity index 92% rename from packages/api-provider/src/coder/json/index.ts rename to packages/rpc-provider/src/coder/json/index.ts index d54a5303240a..73c905801d7f 100644 --- a/packages/api-provider/src/coder/json/index.ts +++ b/packages/rpc-provider/src/coder/json/index.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/coder/json/types.d.ts b/packages/rpc-provider/src/coder/json/types.d.ts similarity index 88% rename from packages/api-provider/src/coder/json/types.d.ts rename to packages/rpc-provider/src/coder/json/types.d.ts index 9459a736b581..33dc6a627aa0 100644 --- a/packages/api-provider/src/coder/json/types.d.ts +++ b/packages/rpc-provider/src/coder/json/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/http/index.spec.js b/packages/rpc-provider/src/http/index.spec.js similarity index 94% rename from packages/api-provider/src/http/index.spec.js rename to packages/rpc-provider/src/http/index.spec.js index 7b68ba6c4979..21d821132699 100644 --- a/packages/api-provider/src/http/index.spec.js +++ b/packages/rpc-provider/src/http/index.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/http/index.ts b/packages/rpc-provider/src/http/index.ts similarity index 95% rename from packages/api-provider/src/http/index.ts rename to packages/rpc-provider/src/http/index.ts index 08624755d343..e39429097045 100644 --- a/packages/api-provider/src/http/index.ts +++ b/packages/rpc-provider/src/http/index.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. @@ -25,8 +25,8 @@ const ERROR_SUBSCRIBE = 'HTTP Provider does not have subscriptions, use WebSocke *
                * * ```javascript - * import Api from '@polkadot/api'; - * import HttpProvider from '@polkadot/api-provider/http'; + * import Api from '@polkadot/rpc-core'; + * import HttpProvider from '@polkadot/rpc-provider/http'; * * const provider = new HttpProvider('http://127.0.0.1:9933'); * const api = new Api(provider); diff --git a/packages/api-provider/src/http/polyfill.spec.js b/packages/rpc-provider/src/http/polyfill.spec.js similarity index 90% rename from packages/api-provider/src/http/polyfill.spec.js rename to packages/rpc-provider/src/http/polyfill.spec.js index 0ca2744dcdca..b85dba898393 100644 --- a/packages/api-provider/src/http/polyfill.spec.js +++ b/packages/rpc-provider/src/http/polyfill.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/http/polyfill.ts b/packages/rpc-provider/src/http/polyfill.ts similarity index 77% rename from packages/api-provider/src/http/polyfill.ts rename to packages/rpc-provider/src/http/polyfill.ts index 55cfc6015b0e..51ed107008d5 100644 --- a/packages/api-provider/src/http/polyfill.ts +++ b/packages/rpc-provider/src/http/polyfill.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/http/send.spec.js b/packages/rpc-provider/src/http/send.spec.js similarity index 94% rename from packages/api-provider/src/http/send.spec.js rename to packages/rpc-provider/src/http/send.spec.js index ee47d29a9382..75e05770aff2 100644 --- a/packages/api-provider/src/http/send.spec.js +++ b/packages/rpc-provider/src/http/send.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/http/types.d.ts b/packages/rpc-provider/src/http/types.d.ts similarity index 82% rename from packages/api-provider/src/http/types.d.ts rename to packages/rpc-provider/src/http/types.d.ts index 150ddff683f6..4afc55da8eea 100644 --- a/packages/api-provider/src/http/types.d.ts +++ b/packages/rpc-provider/src/http/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/index.ts b/packages/rpc-provider/src/index.ts similarity index 77% rename from packages/api-provider/src/index.ts rename to packages/rpc-provider/src/index.ts index f2502b9f3f95..354ffa212e2f 100644 --- a/packages/api-provider/src/index.ts +++ b/packages/rpc-provider/src/index.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/index.ts b/packages/rpc-provider/src/mock/index.ts similarity index 94% rename from packages/api-provider/src/mock/index.ts rename to packages/rpc-provider/src/mock/index.ts index 5bd79ea28a8b..c39701214195 100644 --- a/packages/api-provider/src/mock/index.ts +++ b/packages/rpc-provider/src/mock/index.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/mocks.ts b/packages/rpc-provider/src/mock/mocks.ts similarity index 97% rename from packages/api-provider/src/mock/mocks.ts rename to packages/rpc-provider/src/mock/mocks.ts index 92aea6e2523d..b5b01936227a 100644 --- a/packages/api-provider/src/mock/mocks.ts +++ b/packages/rpc-provider/src/mock/mocks.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/on.ts b/packages/rpc-provider/src/mock/on.ts similarity index 86% rename from packages/api-provider/src/mock/on.ts rename to packages/rpc-provider/src/mock/on.ts index 36def5b39094..dcea57fb25c2 100644 --- a/packages/api-provider/src/mock/on.ts +++ b/packages/rpc-provider/src/mock/on.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/send.ts b/packages/rpc-provider/src/mock/send.ts similarity index 86% rename from packages/api-provider/src/mock/send.ts rename to packages/rpc-provider/src/mock/send.ts index 256c9ac5571e..187ac33658d7 100644 --- a/packages/api-provider/src/mock/send.ts +++ b/packages/rpc-provider/src/mock/send.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/state.spec.js b/packages/rpc-provider/src/mock/state.spec.js similarity index 90% rename from packages/api-provider/src/mock/state.spec.js rename to packages/rpc-provider/src/mock/state.spec.js index 060721f587f5..795b68544f49 100644 --- a/packages/api-provider/src/mock/state.spec.js +++ b/packages/rpc-provider/src/mock/state.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/state.ts b/packages/rpc-provider/src/mock/state.ts similarity index 95% rename from packages/api-provider/src/mock/state.ts rename to packages/rpc-provider/src/mock/state.ts index 55518d556b38..273140e0cd5b 100644 --- a/packages/api-provider/src/mock/state.ts +++ b/packages/rpc-provider/src/mock/state.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/subscribe.spec.js b/packages/rpc-provider/src/mock/subscribe.spec.js similarity index 95% rename from packages/api-provider/src/mock/subscribe.spec.js rename to packages/rpc-provider/src/mock/subscribe.spec.js index 2112e37d7f19..34fd6095e5c2 100644 --- a/packages/api-provider/src/mock/subscribe.spec.js +++ b/packages/rpc-provider/src/mock/subscribe.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/subscribe.ts b/packages/rpc-provider/src/mock/subscribe.ts similarity index 92% rename from packages/api-provider/src/mock/subscribe.ts rename to packages/rpc-provider/src/mock/subscribe.ts index 759ef43c7f2d..5b830e873fb3 100644 --- a/packages/api-provider/src/mock/subscribe.ts +++ b/packages/rpc-provider/src/mock/subscribe.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/types.d.ts b/packages/rpc-provider/src/mock/types.d.ts similarity index 93% rename from packages/api-provider/src/mock/types.d.ts rename to packages/rpc-provider/src/mock/types.d.ts index 8bb1520de224..1988ecd0abe4 100644 --- a/packages/api-provider/src/mock/types.d.ts +++ b/packages/rpc-provider/src/mock/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/unsubscribe.spec.js b/packages/rpc-provider/src/mock/unsubscribe.spec.js similarity index 95% rename from packages/api-provider/src/mock/unsubscribe.spec.js rename to packages/rpc-provider/src/mock/unsubscribe.spec.js index e9200666c161..544736717d8e 100644 --- a/packages/api-provider/src/mock/unsubscribe.spec.js +++ b/packages/rpc-provider/src/mock/unsubscribe.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/mock/unsubscribe.ts b/packages/rpc-provider/src/mock/unsubscribe.ts similarity index 89% rename from packages/api-provider/src/mock/unsubscribe.ts rename to packages/rpc-provider/src/mock/unsubscribe.ts index f83ca3a4c0c0..04135cd4dd9c 100644 --- a/packages/api-provider/src/mock/unsubscribe.ts +++ b/packages/rpc-provider/src/mock/unsubscribe.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/types.d.ts b/packages/rpc-provider/src/types.d.ts similarity index 95% rename from packages/api-provider/src/types.d.ts rename to packages/rpc-provider/src/types.d.ts index 5e2b69d04efc..c12a0163b083 100644 --- a/packages/api-provider/src/types.d.ts +++ b/packages/rpc-provider/src/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/connect.spec.js b/packages/rpc-provider/src/ws/connect.spec.js similarity index 91% rename from packages/api-provider/src/ws/connect.spec.js rename to packages/rpc-provider/src/ws/connect.spec.js index 7c13e6bd5d87..174c4fdf3c17 100644 --- a/packages/api-provider/src/ws/connect.spec.js +++ b/packages/rpc-provider/src/ws/connect.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/index.spec.js b/packages/rpc-provider/src/ws/index.spec.js similarity index 90% rename from packages/api-provider/src/ws/index.spec.js rename to packages/rpc-provider/src/ws/index.spec.js index b01b1309fed2..7745b293d7ea 100644 --- a/packages/api-provider/src/ws/index.spec.js +++ b/packages/rpc-provider/src/ws/index.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/index.ts b/packages/rpc-provider/src/ws/index.ts similarity index 98% rename from packages/api-provider/src/ws/index.ts rename to packages/rpc-provider/src/ws/index.ts index 82510a4bb5e1..6069de3e47d4 100644 --- a/packages/api-provider/src/ws/index.ts +++ b/packages/rpc-provider/src/ws/index.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. @@ -46,8 +46,8 @@ interface WSProviderInterface extends ProviderInterface { *
                * * ```javascript - * import Api from '@polkadot/api'; - * import WsProvider from '@polkadot/api-provider/ws'; + * import Api from '@polkadot/rpc-core'; + * import WsProvider from '@polkadot/rpc-provider/ws'; * * const provider = new WsProvider('ws://127.0.0.1:9944'); * const api = new Api(provider); diff --git a/packages/api-provider/src/ws/onError.spec.js b/packages/rpc-provider/src/ws/onError.spec.js similarity index 89% rename from packages/api-provider/src/ws/onError.spec.js rename to packages/rpc-provider/src/ws/onError.spec.js index 2766ff7b0f98..016ac52c4dab 100644 --- a/packages/api-provider/src/ws/onError.spec.js +++ b/packages/rpc-provider/src/ws/onError.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/onMessageResult.spec.js b/packages/rpc-provider/src/ws/onMessageResult.spec.js similarity index 93% rename from packages/api-provider/src/ws/onMessageResult.spec.js rename to packages/rpc-provider/src/ws/onMessageResult.spec.js index cbe11a803278..8fb303a740b6 100644 --- a/packages/api-provider/src/ws/onMessageResult.spec.js +++ b/packages/rpc-provider/src/ws/onMessageResult.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/onMessageSubscribe.spec.js b/packages/rpc-provider/src/ws/onMessageSubscribe.spec.js similarity index 96% rename from packages/api-provider/src/ws/onMessageSubscribe.spec.js rename to packages/rpc-provider/src/ws/onMessageSubscribe.spec.js index 4ced0407f431..c617bcf3ef05 100644 --- a/packages/api-provider/src/ws/onMessageSubscribe.spec.js +++ b/packages/rpc-provider/src/ws/onMessageSubscribe.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/onOpen.spec.js b/packages/rpc-provider/src/ws/onOpen.spec.js similarity index 92% rename from packages/api-provider/src/ws/onOpen.spec.js rename to packages/rpc-provider/src/ws/onOpen.spec.js index 279919e379f2..6bb9a0eab056 100644 --- a/packages/api-provider/src/ws/onOpen.spec.js +++ b/packages/rpc-provider/src/ws/onOpen.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/polyfill.spec.js b/packages/rpc-provider/src/ws/polyfill.spec.js similarity index 90% rename from packages/api-provider/src/ws/polyfill.spec.js rename to packages/rpc-provider/src/ws/polyfill.spec.js index 1f1dee7f67fa..bb8691fe7495 100644 --- a/packages/api-provider/src/ws/polyfill.spec.js +++ b/packages/rpc-provider/src/ws/polyfill.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/polyfill.ts b/packages/rpc-provider/src/ws/polyfill.ts similarity index 80% rename from packages/api-provider/src/ws/polyfill.ts rename to packages/rpc-provider/src/ws/polyfill.ts index e606563fbab1..8cbe86198289 100644 --- a/packages/api-provider/src/ws/polyfill.ts +++ b/packages/rpc-provider/src/ws/polyfill.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/send.spec.js b/packages/rpc-provider/src/ws/send.spec.js similarity index 96% rename from packages/api-provider/src/ws/send.spec.js rename to packages/rpc-provider/src/ws/send.spec.js index e0695608cb0b..23bae3ec4c52 100644 --- a/packages/api-provider/src/ws/send.spec.js +++ b/packages/rpc-provider/src/ws/send.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/state.spec.js b/packages/rpc-provider/src/ws/state.spec.js similarity index 87% rename from packages/api-provider/src/ws/state.spec.js rename to packages/rpc-provider/src/ws/state.spec.js index c5948266327a..8f96506d627b 100644 --- a/packages/api-provider/src/ws/state.spec.js +++ b/packages/rpc-provider/src/ws/state.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/subscribe.spec.js b/packages/rpc-provider/src/ws/subscribe.spec.js similarity index 93% rename from packages/api-provider/src/ws/subscribe.spec.js rename to packages/rpc-provider/src/ws/subscribe.spec.js index ad7412cd3cf5..f44d82d22410 100644 --- a/packages/api-provider/src/ws/subscribe.spec.js +++ b/packages/rpc-provider/src/ws/subscribe.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-provider/src/ws/unsubscribe.spec.js b/packages/rpc-provider/src/ws/unsubscribe.spec.js similarity index 96% rename from packages/api-provider/src/ws/unsubscribe.spec.js rename to packages/rpc-provider/src/ws/unsubscribe.spec.js index 1df76b027e8a..a086e733d582 100644 --- a/packages/api-provider/src/ws/unsubscribe.spec.js +++ b/packages/rpc-provider/src/ws/unsubscribe.spec.js @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/test/mockHttp.ts b/packages/rpc-provider/test/mockHttp.ts similarity index 91% rename from packages/api/test/mockHttp.ts rename to packages/rpc-provider/test/mockHttp.ts index a994a7b188e9..3738c5753ac4 100644 --- a/packages/api/test/mockHttp.ts +++ b/packages/rpc-provider/test/mockHttp.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api/test/mockWs.ts b/packages/rpc-provider/test/mockWs.ts similarity index 96% rename from packages/api/test/mockWs.ts rename to packages/rpc-provider/test/mockWs.ts index bae2b3671844..cda2cff95370 100644 --- a/packages/api/test/mockWs.ts +++ b/packages/rpc-provider/test/mockWs.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-provider authors & contributors +// Copyright 2017-2018 @polkadot/rpc-provider authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-rx/LICENSE b/packages/rpc-rx/LICENSE similarity index 92% rename from packages/api-rx/LICENSE rename to packages/rpc-rx/LICENSE index 34f3755044b8..b9ab3e9f0c4b 100644 --- a/packages/api-rx/LICENSE +++ b/packages/rpc-rx/LICENSE @@ -1,6 +1,6 @@ ISC License (ISC) -Copyright 2017-2018 @polkadot/api-rx authors & contributors +Copyright 2017-2018 @polkadot/rpc-rx authors & contributors Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/packages/api-rx/README.md b/packages/rpc-rx/README.md similarity index 72% rename from packages/api-rx/README.md rename to packages/rpc-rx/README.md index d2f465c2c466..3c7a46f8f753 100644 --- a/packages/api-rx/README.md +++ b/packages/rpc-rx/README.md @@ -1,13 +1,13 @@ [![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) -[![npm](https://img.shields.io/npm/v/@polkadot/api-rx.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-rx) +[![npm](https://img.shields.io/npm/v/@polkadot/rpc-rx.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/rpc-rx) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) -[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx) -[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx#info=devDependencies) +[![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/rpc-rx)](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx) +[![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/rpc-rx)](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx#info=devDependencies) -# @polkadot/api-rx +# @polkadot/rpc-rx An RxJs wrapper around the [@polkadot/api](../api). diff --git a/packages/api-rx/package.json b/packages/rpc-rx/package.json similarity index 85% rename from packages/api-rx/package.json rename to packages/rpc-rx/package.json index c17a998b78b6..8ca79488836a 100644 --- a/packages/api-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,5 +1,5 @@ { - "name": "@polkadot/api-rx", + "name": "@polkadot/rpc-rx", "version": "0.30.33", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", @@ -27,11 +27,11 @@ "bugs": { "url": "https://github.com/polkadot-js/api/issues" }, - "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-rx#readme", + "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/api": "^0.30.33", - "@polkadot/api-provider": "^0.30.33", + "@polkadot/rpc-core": "^0.30.33", + "@polkadot/rpc-provider": "^0.30.33", "@types/rx": "^4.1.1", "rxjs": "^6.3.2" } diff --git a/packages/api-rx/src/cached.spec.js b/packages/rpc-rx/src/cached.spec.js similarity index 94% rename from packages/api-rx/src/cached.spec.js rename to packages/rpc-rx/src/cached.spec.js index dca495bdc56e..0f8e5b36b85e 100644 --- a/packages/api-rx/src/cached.spec.js +++ b/packages/rpc-rx/src/cached.spec.js @@ -1,8 +1,8 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -jest.mock('@polkadot/api-provider/ws', () => class { +jest.mock('@polkadot/rpc-provider/ws', () => class { isConnected = () => true; on = () => true; send = () => true; diff --git a/packages/api-rx/src/defaults.ts b/packages/rpc-rx/src/defaults.ts similarity index 75% rename from packages/api-rx/src/defaults.ts rename to packages/rpc-rx/src/defaults.ts index 813dc70a850f..eb6c30ea4510 100644 --- a/packages/api-rx/src/defaults.ts +++ b/packages/rpc-rx/src/defaults.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-rx/src/index.spec.js b/packages/rpc-rx/src/index.spec.js similarity index 86% rename from packages/api-rx/src/index.spec.js rename to packages/rpc-rx/src/index.spec.js index c2686bd2fb34..cfe94a2e21e5 100644 --- a/packages/api-rx/src/index.spec.js +++ b/packages/rpc-rx/src/index.spec.js @@ -1,10 +1,10 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. import isFunction from '@polkadot/util/is/function'; -jest.mock('@polkadot/api-provider/ws', () => class { +jest.mock('@polkadot/rpc-provider/ws', () => class { isConnected = () => true; on = () => true; send = () => true; diff --git a/packages/api-rx/src/index.ts b/packages/rpc-rx/src/index.ts similarity index 92% rename from packages/api-rx/src/index.ts rename to packages/rpc-rx/src/index.ts index c0f53a4d9b72..74e955101018 100644 --- a/packages/api-rx/src/index.ts +++ b/packages/rpc-rx/src/index.ts @@ -1,14 +1,14 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { ApiInterface, ApiInterface$Section } from '@polkadot/api/types'; -import { ProviderInterface } from '@polkadot/api-provider/types'; +import { ApiInterface, ApiInterface$Section } from '@polkadot/rpc-core/types'; +import { ProviderInterface } from '@polkadot/rpc-provider/types'; import { RxApiInterface, RxApiInterface$Section } from './types'; import { BehaviorSubject, Observable, Subscriber, from } from 'rxjs'; -import Api from '@polkadot/api/index'; -import Ws from '@polkadot/api-provider/ws'; +import Api from '@polkadot/rpc-core/index'; +import Ws from '@polkadot/rpc-provider/ws'; import isFunction from '@polkadot/util/is/function'; import isUndefined from '@polkadot/util/is/undefined'; @@ -29,8 +29,8 @@ type CachedMap = { *
                * * ```javascript - * import RxApi from '@polkadot/api'; - * import WsProvider from '@polkadot/api-provider/ws'; + * import RxApi from '@polkadot/rpc-core'; + * import WsProvider from '@polkadot/rpc-provider/ws'; * * const provider = new WsProvider('http://127.0.0.1:9944'); * const rxapi = new RxApi(provider); diff --git a/packages/api-rx/src/subject.spec.js b/packages/rpc-rx/src/subject.spec.js similarity index 93% rename from packages/api-rx/src/subject.spec.js rename to packages/rpc-rx/src/subject.spec.js index 07c901819e41..06285ff8207e 100644 --- a/packages/api-rx/src/subject.spec.js +++ b/packages/rpc-rx/src/subject.spec.js @@ -1,8 +1,8 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -jest.mock('@polkadot/api-provider/ws', () => class { +jest.mock('@polkadot/rpc-provider/ws', () => class { isConnected = () => true; on = () => true; send = () => true; diff --git a/packages/api-rx/src/types.d.ts b/packages/rpc-rx/src/types.d.ts similarity index 91% rename from packages/api-rx/src/types.d.ts rename to packages/rpc-rx/src/types.d.ts index ad25821f5d82..97f3cdb5fde0 100644 --- a/packages/api-rx/src/types.d.ts +++ b/packages/rpc-rx/src/types.d.ts @@ -1,4 +1,4 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. diff --git a/packages/api-rx/test/e2e/subscribe.test.js b/packages/rpc-rx/test/e2e/subscribe.test.js similarity index 90% rename from packages/api-rx/test/e2e/subscribe.test.js rename to packages/rpc-rx/test/e2e/subscribe.test.js index 710ccf2112c3..30d8ab260b77 100644 --- a/packages/api-rx/test/e2e/subscribe.test.js +++ b/packages/rpc-rx/test/e2e/subscribe.test.js @@ -1,8 +1,8 @@ -// Copyright 2017-2018 @polkadot/api-rx authors & contributors +// Copyright 2017-2018 @polkadot/rpc-rx authors & contributors // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Ws from '@polkadot/api-provider/ws'; +import Ws from '@polkadot/rpc-provider/ws'; import storage from '@polkadot/storage/static'; import RxApi from '../../src'; diff --git a/packages/type-extrinsics/test/e2e/transfer.spec.js b/packages/type-extrinsics/test/e2e/transfer.spec.js index 68138d3b84d4..e3ba2a61d435 100644 --- a/packages/type-extrinsics/test/e2e/transfer.spec.js +++ b/packages/type-extrinsics/test/e2e/transfer.spec.js @@ -2,9 +2,9 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import Api from '@polkadot/api'; +import Api from '@polkadot/rpc-core'; +import Ws from '@polkadot/rpc-provider/ws'; import testingPairs from '@polkadot/util-keyring/testingPairs'; -import Ws from '@polkadot/api-provider/ws'; import extrinsics from '../../src/static'; diff --git a/tsconfig.json b/tsconfig.json index 19270bd7bd4d..b189402d53ea 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -6,9 +6,9 @@ "paths": { "@polkadot/api-observable/*": ["packages/api-observable/src/*"], - "@polkadot/api-provider/*": ["packages/api-provider/src/*"], - "@polkadot/api-rx/*": ["packages/api-rx/src/*"], - "@polkadot/api/*": ["packages/api/src/*"], + "@polkadot/rpc-core/*": ["packages/rpc-core/src/*"], + "@polkadot/rpc-provider/*": ["packages/rpc-provider/src/*"], + "@polkadot/rpc-rx/*": ["packages/rpc-rx/src/*"], "@polkadot/extrinsics/*": ["packages/type-extrinsics/src/*"], "@polkadot/jsonrpc/*": ["packages/type-jsonrpc/src/*"], "@polkadot/params/*": ["packages/type-params/src/*"], From f43eaecb7f9304f2eaac544e1fd1ac355973d367 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sat, 6 Oct 2018 17:04:15 +0200 Subject: [PATCH 3/9] Apoi -> Rpc, RxApi -> RpcRx (classes) --- packages/api-observable/src/Base.ts | 10 ++++---- packages/rpc-core/src/index.ts | 30 ++++++++++++------------ packages/rpc-core/src/types.d.ts | 10 ++++---- packages/rpc-rx/src/index.ts | 36 ++++++++++++++--------------- packages/rpc-rx/src/types.d.ts | 16 ++++++------- 5 files changed, 51 insertions(+), 51 deletions(-) diff --git a/packages/api-observable/src/Base.ts b/packages/api-observable/src/Base.ts index 471ab1bb9eae..03073728e0cf 100644 --- a/packages/api-observable/src/Base.ts +++ b/packages/api-observable/src/Base.ts @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { RxApiInterface, RxApiInterface$Method, RxApiInterface$Section } from '@polkadot/rpc-rx/types'; +import { RxRpcInterface, RxRpcInterface$Method, RxRpcInterface$Section } from '@polkadot/rpc-rx/types'; import { RpcMethod } from '@polkadot/jsonrpc/types'; import { EMPTY, Observable, combineLatest, from } from 'rxjs'; @@ -25,13 +25,13 @@ const defaultMapFn = (result: any): any => // Raw base implementation for the observable API. It simply provides access to raw calls, allowing // decendants to make direct queries to either API methods or actual storage export default class ApiBase { - protected _api: RxApiInterface; + protected _api: RxRpcInterface; protected _genesisHash: Hash; // Observable that returns the first time we are connected and loaded whenReady: Observable; - constructor (api: RxApiInterface) { + constructor (api: RxRpcInterface) { this._api = api; this._genesisHash = new Hash(); this.whenReady = from(this.init()); @@ -84,11 +84,11 @@ export default class ApiBase { } rawCall = ({ method, section }: RpcMethod, ...params: Array): Observable => { - const apiSection = this._api[section as keyof RxApiInterface] as RxApiInterface$Section; + const apiSection = this._api[section as keyof RxRpcInterface] as RxRpcInterface$Section; assert(apiSection, `Unable to find 'api.${section}'`); - const fn: RxApiInterface$Method = apiSection[method]; + const fn: RxRpcInterface$Method = apiSection[method]; assert(fn, `Unable to find 'api.${section}.${method}'`); diff --git a/packages/rpc-core/src/index.ts b/packages/rpc-core/src/index.ts index 434a24fbd6fd..65ba33511408 100644 --- a/packages/rpc-core/src/index.ts +++ b/packages/rpc-core/src/index.ts @@ -4,7 +4,7 @@ import { ProviderInterface, ProviderInterface$Callback } from '@polkadot/rpc-provider/types'; import { RpcSection, RpcMethod } from '@polkadot/jsonrpc/types'; -import { ApiInterface, ApiInterface$Section, ApiInterface$Section$Method } from './types'; +import { RpcInterface, RpcInterface$Section, RpcInterface$Section$Method } from './types'; import { Base, Vector, createType } from '@polkadot/types/codec'; import { StorageChangeSet, StorageKey } from '@polkadot/types/index'; @@ -14,7 +14,7 @@ import ExtError from '@polkadot/util/ext/error'; import isFunction from '@polkadot/util/is/function'; /** - * @name Api + * @name Rpc * @summary The API may use a HTTP or WebSockets provider. * @description It allows for querying a Polkadot Client Node. * @example @@ -28,12 +28,12 @@ import isFunction from '@polkadot/util/is/function'; * const api = new Api(provider); * ``` */ -export default class Api implements ApiInterface { +export default class Rpc implements RpcInterface { private _provider: ProviderInterface; - readonly author: ApiInterface$Section; - readonly chain: ApiInterface$Section; - readonly state: ApiInterface$Section; - readonly system: ApiInterface$Section; + readonly author: RpcInterface$Section; + readonly chain: RpcInterface$Section; + readonly state: RpcInterface$Section; + readonly system: RpcInterface$Section; /** * @constructor @@ -74,7 +74,7 @@ export default class Api implements ApiInterface { return `${method} (${inputs}): ${type}`; } - private createInterface ({ methods, section }: RpcSection): ApiInterface$Section { + private createInterface ({ methods, section }: RpcSection): RpcInterface$Section { return Object .keys(methods) .reduce((exposed, method) => { @@ -86,10 +86,10 @@ export default class Api implements ApiInterface { : this.createMethodSend(rpcName, def); return exposed; - }, {} as ApiInterface$Section); + }, {} as RpcInterface$Section); } - private createMethodSend (rpcName: string, method: RpcMethod): ApiInterface$Section$Method { + private createMethodSend (rpcName: string, method: RpcMethod): RpcInterface$Section$Method { const call = async (...values: Array): Promise => { // TODO Warn on deprecated methods try { @@ -99,7 +99,7 @@ export default class Api implements ApiInterface { return this.formatOutput(method, params, result); } catch (error) { - const message = `${Api.signature(method)}:: ${error.message}`; + const message = `${Rpc.signature(method)}:: ${error.message}`; console.error(message, error); @@ -107,10 +107,10 @@ export default class Api implements ApiInterface { } }; - return call as ApiInterface$Section$Method; + return call as RpcInterface$Section$Method; } - private createMethodSubscribe (rpcName: string, method: RpcMethod): ApiInterface$Section$Method { + private createMethodSubscribe (rpcName: string, method: RpcMethod): RpcInterface$Section$Method { const unsubscribe = (subscriptionId: any): Promise => this._provider.unsubscribe(rpcName, method.subscribe[1], subscriptionId); const _call = async (...values: Array): Promise => { @@ -127,7 +127,7 @@ export default class Api implements ApiInterface { return this._provider.subscribe(rpcName, method.subscribe[0], paramsJson, update); } catch (error) { - const message = `${Api.signature(method)}:: ${error.message}`; + const message = `${Rpc.signature(method)}:: ${error.message}`; console.error(message, error); @@ -135,7 +135,7 @@ export default class Api implements ApiInterface { } }; - const call = _call as ApiInterface$Section$Method; + const call = _call as RpcInterface$Section$Method; call.unsubscribe = unsubscribe; diff --git a/packages/rpc-core/src/types.d.ts b/packages/rpc-core/src/types.d.ts index 9466acdb8fce..8c626f40bbb8 100644 --- a/packages/rpc-core/src/types.d.ts +++ b/packages/rpc-core/src/types.d.ts @@ -4,17 +4,17 @@ import interfaces from '@polkadot/jsonrpc/index'; -export interface ApiInterface$Section$Method { +export interface RpcInterface$Section$Method { (...params: Array): Promise; subscription: string; unsubscribe: (id: number) => Promise; } -export type ApiInterface$Section = { - [index: string]: ApiInterface$Section$Method +export type RpcInterface$Section = { + [index: string]: RpcInterface$Section$Method }; -export type ApiInterface = { - readonly [key in keyof typeof interfaces]: ApiInterface$Section +export type RpcInterface = { + readonly [key in keyof typeof interfaces]: RpcInterface$Section } diff --git a/packages/rpc-rx/src/index.ts b/packages/rpc-rx/src/index.ts index 74e955101018..130e1a5393f3 100644 --- a/packages/rpc-rx/src/index.ts +++ b/packages/rpc-rx/src/index.ts @@ -2,12 +2,12 @@ // This software may be modified and distributed under the terms // of the ISC license. See the LICENSE file for details. -import { ApiInterface, ApiInterface$Section } from '@polkadot/rpc-core/types'; +import { RpcInterface, RpcInterface$Section } from '@polkadot/rpc-core/types'; import { ProviderInterface } from '@polkadot/rpc-provider/types'; -import { RxApiInterface, RxApiInterface$Section } from './types'; +import { RxRpcInterface, RxRpcInterface$Section } from './types'; import { BehaviorSubject, Observable, Subscriber, from } from 'rxjs'; -import Api from '@polkadot/rpc-core/index'; +import Rpc from '@polkadot/rpc-core/index'; import Ws from '@polkadot/rpc-provider/ws'; import isFunction from '@polkadot/util/is/function'; import isUndefined from '@polkadot/util/is/undefined'; @@ -21,7 +21,7 @@ type CachedMap = { }; /** - * @name RxApi + * @name RpcRx * @summary The RxJS API is a wrapper around the API. * @description It allows wrapping API components with observables using RxJS. * @@ -29,27 +29,27 @@ type CachedMap = { *
                * * ```javascript - * import RxApi from '@polkadot/rpc-core'; + * import Rpc from '@polkadot/rpc-rx'; * import WsProvider from '@polkadot/rpc-provider/ws'; * * const provider = new WsProvider('http://127.0.0.1:9944'); - * const rxapi = new RxApi(provider); + * const api = new Rpc(provider); * ``` */ -export default class RxApi implements RxApiInterface { - private _api: ApiInterface; +export default class RpcRx implements RxRpcInterface { + private _api: RpcInterface; private _cacheMap: CachedMap; private _isConnected: BehaviorSubject; - readonly author: RxApiInterface$Section; - readonly chain: RxApiInterface$Section; - readonly state: RxApiInterface$Section; - readonly system: RxApiInterface$Section; + readonly author: RxRpcInterface$Section; + readonly chain: RxRpcInterface$Section; + readonly state: RxRpcInterface$Section; + readonly system: RxRpcInterface$Section; /** * @param {ProviderInterface} provider An API provider using HTTP or WebSocket */ constructor (provider: ProviderInterface = new Ws(defaults.WS_URL)) { - this._api = new Api(provider); + this._api = new Rpc(provider); this._cacheMap = {}; this._isConnected = new BehaviorSubject(provider.isConnected()); @@ -66,7 +66,7 @@ export default class RxApi implements RxApiInterface { return this._isConnected; } - private createInterface (sectionName: string, section: ApiInterface$Section): RxApiInterface$Section { + private createInterface (sectionName: string, section: RpcInterface$Section): RxRpcInterface$Section { return Object .keys(section) .filter((name) => !['subscribe', 'unsubscribe'].includes(name)) @@ -74,10 +74,10 @@ export default class RxApi implements RxApiInterface { observables[name] = this.createObservable(`${sectionName}_${name}`, name, section); return observables; - }, ({} as RxApiInterface$Section)); + }, ({} as RxRpcInterface$Section)); } - private createObservable (subName: string, name: string, section: ApiInterface$Section): (...params: Array) => Observable | BehaviorSubject { + private createObservable (subName: string, name: string, section: RpcInterface$Section): (...params: Array) => Observable | BehaviorSubject { if (isFunction(section[name].unsubscribe)) { return this.createCachedObservable(subName, name, section); } @@ -92,7 +92,7 @@ export default class RxApi implements RxApiInterface { ); } - private createCachedObservable (subName: string, name: string, section: ApiInterface$Section): (...params: Array) => BehaviorSubject { + private createCachedObservable (subName: string, name: string, section: RpcInterface$Section): (...params: Array) => BehaviorSubject { if (!this._cacheMap[subName]) { this._cacheMap[subName] = {}; } @@ -108,7 +108,7 @@ export default class RxApi implements RxApiInterface { }; } - private createSubject (name: string, params: Array, section: ApiInterface$Section, unsubCallback?: () => void): BehaviorSubject { + private createSubject (name: string, params: Array, section: RpcInterface$Section, unsubCallback?: () => void): BehaviorSubject { const subject = new BehaviorSubject(undefined); Observable diff --git a/packages/rpc-rx/src/types.d.ts b/packages/rpc-rx/src/types.d.ts index 97f3cdb5fde0..0a79430f15b4 100644 --- a/packages/rpc-rx/src/types.d.ts +++ b/packages/rpc-rx/src/types.d.ts @@ -6,17 +6,17 @@ import { BehaviorSubject, Observable } from 'rxjs'; import interfaces from '@polkadot/jsonrpc/types'; -export type RxApiInterface$Method = (...params: Array) => Observable | BehaviorSubject; +export type RxRpcInterface$Method = (...params: Array) => Observable | BehaviorSubject; -export type RxApiInterface$Section = { - [index: string]: RxApiInterface$Method +export type RxRpcInterface$Section = { + [index: string]: RxRpcInterface$Method }; -export type RxApiInterface = { - readonly author: RxApiInterface$Section; - readonly chain: RxApiInterface$Section; - readonly state: RxApiInterface$Section; - readonly system: RxApiInterface$Section; +export type RxRpcInterface = { + readonly author: RxRpcInterface$Section; + readonly chain: RxRpcInterface$Section; + readonly state: RxRpcInterface$Section; + readonly system: RxRpcInterface$Section; isConnected: () => BehaviorSubject } From 532843eec05829ebc33f9be1f8a924d20501963d Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sun, 7 Oct 2018 17:07:48 +0200 Subject: [PATCH 4/9] Add .nodoc --- packages/api-observable/.nodoc | 0 packages/types/.nodoc | 0 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 packages/api-observable/.nodoc create mode 100644 packages/types/.nodoc diff --git a/packages/api-observable/.nodoc b/packages/api-observable/.nodoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/types/.nodoc b/packages/types/.nodoc new file mode 100644 index 000000000000..e69de29bb2d1 From c6db6f9e472545b8c855c95a8e5f8a23a7cfe29f Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Tue, 9 Oct 2018 20:29:57 +0200 Subject: [PATCH 5/9] Bump version --- docs/examples/01_simple_connect/package.json | 4 ++-- docs/examples/02_listen_to_blocks/package.json | 2 +- docs/examples/03_listen_to_balance_change/package.json | 2 +- docs/examples/04_generate_account/package.json | 2 +- docs/examples/05_read_storage/package.json | 2 +- docs/examples/06_craft_extrinsic/package.json | 2 +- docs/examples/07_transfer_dots/package.json | 2 +- lerna.json | 2 +- packages/api-observable/package.json | 6 +++--- packages/rpc-core/package.json | 6 +++--- packages/rpc-provider/package.json | 4 ++-- packages/rpc-rx/package.json | 6 +++--- packages/type-extrinsics/package.json | 2 +- packages/type-jsonrpc/package.json | 2 +- packages/type-storage/package.json | 4 ++-- packages/types/package.json | 2 +- 16 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/examples/01_simple_connect/package.json b/docs/examples/01_simple_connect/package.json index e857a1186c62..a6bad168b092 100644 --- a/docs/examples/01_simple_connect/package.json +++ b/docs/examples/01_simple_connect/package.json @@ -11,8 +11,8 @@ }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", - "@polkadot/rpc-provider": "^0.30.1" + "@polkadot/rpc-core": "^0.31.1", + "@polkadot/rpc-provider": "^0.31.1" }, "devDependencies": { "rimraf": "^2.6.2" diff --git a/docs/examples/02_listen_to_blocks/package.json b/docs/examples/02_listen_to_blocks/package.json index 09aa8f45b31b..06ef3515ff5d 100644 --- a/docs/examples/02_listen_to_blocks/package.json +++ b/docs/examples/02_listen_to_blocks/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/03_listen_to_balance_change/package.json b/docs/examples/03_listen_to_balance_change/package.json index 251f3b3f17d0..a298c028163c 100644 --- a/docs/examples/03_listen_to_balance_change/package.json +++ b/docs/examples/03_listen_to_balance_change/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/04_generate_account/package.json b/docs/examples/04_generate_account/package.json index 8c4086505926..b06a27f1c416 100644 --- a/docs/examples/04_generate_account/package.json +++ b/docs/examples/04_generate_account/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "@polkadot/util": "0.30.3", "@polkadot/util-keyring": "0.30.3" }, diff --git a/docs/examples/05_read_storage/package.json b/docs/examples/05_read_storage/package.json index 1d597e6b19fd..abb7ca6b7532 100644 --- a/docs/examples/05_read_storage/package.json +++ b/docs/examples/05_read_storage/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/06_craft_extrinsic/package.json b/docs/examples/06_craft_extrinsic/package.json index 4d45c436316d..211b10fdda41 100644 --- a/docs/examples/06_craft_extrinsic/package.json +++ b/docs/examples/06_craft_extrinsic/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/docs/examples/07_transfer_dots/package.json b/docs/examples/07_transfer_dots/package.json index 6141954db73b..d59657541eb6 100644 --- a/docs/examples/07_transfer_dots/package.json +++ b/docs/examples/07_transfer_dots/package.json @@ -10,7 +10,7 @@ "start": "node index.js" }, "dependencies": { - "@polkadot/rpc-core": "^0.30.1", + "@polkadot/rpc-core": "^0.31.1", "bn.js": "^4.11.8" }, "devDependencies": { diff --git a/lerna.json b/lerna.json index 159fb0b7ccf9..34970b432915 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.30.44" + "version": "0.31.0" } diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index b921b8a73d4e..d367dd58f2ae 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-observable", - "version": "0.30.44", + "version": "0.31.0", "description": "An Observable wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -32,8 +32,8 @@ "@babel/runtime": "^7.0.0", "@polkadot/api": "^0.30.44", "@polkadot/api-provider": "^0.30.44", - "@polkadot/extrinsics": "^0.30.44", - "@polkadot/storage": "^0.30.44", + "@polkadot/extrinsics": "^0.31.0", + "@polkadot/storage": "^0.31.0", "@types/rx": "^4.1.1", "rxjs": "^6.3.2" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 88731919b483..6fc330921829 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.30.44", + "version": "0.31.0", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/rpc-provider": "^0.30.44", - "@polkadot/jsonrpc": "^0.30.44", + "@polkadot/jsonrpc": "^0.31.0", + "@polkadot/rpc-provider": "^0.31.0", "@polkadot/util": "^0.30.7" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index f4e01e8f9c07..40ac76d2574b 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.30.44", + "version": "0.31.0", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -30,7 +30,7 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/storage": "^0.30.44", + "@polkadot/storage": "^0.31.0", "@polkadot/util": "^0.30.7", "@polkadot/util-crypto": "^0.30.7", "@polkadot/util-keyring": "^0.30.7", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index 84c7b8e20fb9..2d09217f534b 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.30.44", + "version": "0.31.0", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.0.0", - "@polkadot/rpc-core": "^0.30.44", - "@polkadot/rpc-provider": "^0.30.44", + "@polkadot/rpc-core": "^0.31.0", + "@polkadot/rpc-provider": "^0.31.0", "@types/rx": "^4.1.1", "rxjs": "^6.3.2" } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index 61f3a22eeae2..ed84ec57a949 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.30.44", + "version": "0.31.0", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 8c3acfe63faf..e81ae7291f13 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.30.44", + "version": "0.31.0", "description": "Method definitions for the Polkadot RPC layer", "main": "index.js", "engines": { diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index 8d179df5c7d9..f70bde397f4b 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.30.44", + "version": "0.31.0", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -32,7 +32,7 @@ "@babel/runtime": "^7.0.0", "@polkadot/params": "^0.30.3", "@polkadot/primitives": "^0.30.3", - "@polkadot/types": "^0.30.44", + "@polkadot/types": "^0.31.0", "@polkadot/util": "^0.30.7", "@polkadot/util-crypto": "^0.30.7", "@polkadot/util-keyring": "^0.30.7" diff --git a/packages/types/package.json b/packages/types/package.json index 57383db88ead..d5c222a041e4 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.30.44", + "version": "0.31.0", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [ From 07eefba53595c44a239163d125c4307c5d359e13 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 10 Oct 2018 09:31:00 +0200 Subject: [PATCH 6/9] Link updates (summary) --- docs/SUMMARY.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 797c99da051d..94d7ad60730f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,12 +1,12 @@ ## Packages -- [api](api/README.md) - - [Api](api/classes/_index_.api.md) -- [api-provider](api-provider/README.md) - - [HttpProvider](api-provider/classes/_http_index_.httpprovider.md) - - [WsProvider](api-provider/classes/_ws_index_.wsprovider.md) -- [api-rx](api-rx/README.md) - - [ApiRx](api-rx/classes/_index_.rxapi.md) +- [rpc-core](rpc-core/README.md) + - [Rpc](rpc-core/classes/_index_.rpc.md) +- [rpc-provider](rpc-provider/README.md) + - [HttpProvider](rpc-provider/classes/_http_index_.httpprovider.md) + - [WsProvider](rpc-provider/classes/_ws_index_.wsprovider.md) +- [rpc-rx](rpc-rx/README.md) + - [RpcRx](rpc-rx/classes/_index_.rxapi.md) ## Examples From d6da0043d3cdeb1a456d257c02a604c1b658c412 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 10 Oct 2018 09:41:07 +0200 Subject: [PATCH 7/9] Cleanup deleted (master version) --- docs/api-observable/README.md | 8 ++++++++ docs/api-observable/SUMMARY.md | 15 +++++++++++++++ docs/api-observable/modules/_base_.md | 10 ++++++++++ docs/api-observable/modules/_calls_.md | 10 ++++++++++ docs/api-observable/modules/_classes_.md | 12 ++++++++++++ docs/api-observable/modules/_combined_.md | 10 ++++++++++ docs/api-observable/modules/_index_.md | 10 ++++++++++ docs/api-observable/modules/_queries_.md | 10 ++++++++++ 8 files changed, 85 insertions(+) create mode 100644 docs/api-observable/README.md create mode 100644 docs/api-observable/SUMMARY.md create mode 100644 docs/api-observable/modules/_base_.md create mode 100644 docs/api-observable/modules/_calls_.md create mode 100644 docs/api-observable/modules/_classes_.md create mode 100644 docs/api-observable/modules/_combined_.md create mode 100644 docs/api-observable/modules/_index_.md create mode 100644 docs/api-observable/modules/_queries_.md diff --git a/docs/api-observable/README.md b/docs/api-observable/README.md new file mode 100644 index 000000000000..29ffd72c7b1a --- /dev/null +++ b/docs/api-observable/README.md @@ -0,0 +1,8 @@ + +[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-observable.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-observable) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-observable)](https://david-dm.org/polkadot-js/api?path=packages/api-observable#info=devDependencies) + +@polkadot/api-observable +======================== + +An RxJs wrapper around the [@polkadot/api](../api). + diff --git a/docs/api-observable/SUMMARY.md b/docs/api-observable/SUMMARY.md new file mode 100644 index 000000000000..0532061d7428 --- /dev/null +++ b/docs/api-observable/SUMMARY.md @@ -0,0 +1,15 @@ +* ["Base"](modules/_base_.md) + * [ApiBase](classes/_base_.apibase.md) +* ["Calls"](modules/_calls_.md) + * [ApiCalls](classes/_calls_.apicalls.md) +* ["Combined"](modules/_combined_.md) + * [ApiCombined](classes/_combined_.apicombined.md) +* ["Queries"](modules/_queries_.md) + * [ApiQueries](classes/_queries_.apiqueries.md) +* ["classes"](modules/_classes_.md) + * [RxProposal](classes/_classes_.rxproposal.md) + * [RxProposalDeposits](classes/_classes_.rxproposaldeposits.md) + * [RxReferendum](classes/_classes_.rxreferendum.md) +* ["index"](modules/_index_.md) + * [Api](classes/_index_.api.md) +* ["types.d"](modules/_types_d_.md) diff --git a/docs/api-observable/modules/_base_.md b/docs/api-observable/modules/_base_.md new file mode 100644 index 000000000000..4e6114961b65 --- /dev/null +++ b/docs/api-observable/modules/_base_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ApiBase](../classes/_base_.apibase.md) + +--- + diff --git a/docs/api-observable/modules/_calls_.md b/docs/api-observable/modules/_calls_.md new file mode 100644 index 000000000000..7942fe1908ed --- /dev/null +++ b/docs/api-observable/modules/_calls_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ApiCalls](../classes/_calls_.apicalls.md) + +--- + diff --git a/docs/api-observable/modules/_classes_.md b/docs/api-observable/modules/_classes_.md new file mode 100644 index 000000000000..b82aeb77ee67 --- /dev/null +++ b/docs/api-observable/modules/_classes_.md @@ -0,0 +1,12 @@ + + +# Index + +### Classes + +* [RxProposal](../classes/_classes_.rxproposal.md) +* [RxProposalDeposits](../classes/_classes_.rxproposaldeposits.md) +* [RxReferendum](../classes/_classes_.rxreferendum.md) + +--- + diff --git a/docs/api-observable/modules/_combined_.md b/docs/api-observable/modules/_combined_.md new file mode 100644 index 000000000000..cbd7d10ead1b --- /dev/null +++ b/docs/api-observable/modules/_combined_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ApiCombined](../classes/_combined_.apicombined.md) + +--- + diff --git a/docs/api-observable/modules/_index_.md b/docs/api-observable/modules/_index_.md new file mode 100644 index 000000000000..7e08da80695e --- /dev/null +++ b/docs/api-observable/modules/_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Api](../classes/_index_.api.md) + +--- + diff --git a/docs/api-observable/modules/_queries_.md b/docs/api-observable/modules/_queries_.md new file mode 100644 index 000000000000..b9d69fbcfc31 --- /dev/null +++ b/docs/api-observable/modules/_queries_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [ApiQueries](../classes/_queries_.apiqueries.md) + +--- + From 9f0c3c459015ace315e5f77cd3994f0d2b439110 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 10 Oct 2018 09:43:03 +0200 Subject: [PATCH 8/9] Deleted re-instated --- docs/api-provider/README.md | 28 + docs/api-provider/SUMMARY.md | 23 + ...rovider.eventemitter.eventemitterstatic.md | 24 + ...dex_.wsprovider.eventemitter.listenerfn.md | 19 + docs/api-provider/modules/_http_index_.md | 10 + docs/api-provider/modules/_http_polyfill_.md | 2 + docs/api-provider/modules/_index_.md | 2 + docs/api-provider/modules/_ws_index_.md | 10 + .../_ws_index_.wsprovider.eventemitter.md | 27 + docs/api-provider/modules/_ws_polyfill_.md | 2 + docs/api-rx/README.md | 8 + docs/api-rx/SUMMARY.md | 4 + docs/api-rx/modules/_defaults_.md | 2 + docs/api-rx/modules/_index_.md | 10 + docs/api/README.md | 72 ++ docs/api/SUMMARY.md | 4 + docs/api/modules/_index_.md | 10 + docs/classes/_http_index_.httpprovider.html | 623 ++++++++++++ docs/classes/_http_index_.httpprovider.md | 159 +++ docs/classes/_ws_index_.wsprovider.html | 904 ++++++++++++++++++ docs/classes/_ws_index_.wsprovider.md | 392 ++++++++ .../interfaces/_types_d_.providerinterface.md | 99 ++ ...rovider.eventemitter.eventemitterstatic.md | 24 + ...dex_.wsprovider.eventemitter.listenerfn.md | 19 + docs/modules/_coder_json_decoderesponse_.md | 23 + docs/modules/_coder_json_encodejson_.md | 24 + docs/modules/_coder_json_encodeobject_.md | 24 + docs/modules/_coder_json_index_.md | 16 + docs/modules/_coder_json_types_d_.md | 27 + docs/modules/_http_index_.md | 10 + docs/modules/_http_polyfill_.md | 2 + docs/modules/_http_types_d_.md | 16 + docs/modules/_index_.md | 2 + docs/modules/_mock_index_.md | 19 + docs/modules/_mock_mocks_.md | 22 + docs/modules/_mock_on_.md | 24 + docs/modules/_mock_send_.md | 24 + docs/modules/_mock_state_.md | 16 + docs/modules/_mock_subscribe_.md | 25 + docs/modules/_mock_types_d_.md | 87 ++ docs/modules/_mock_unsubscribe_.md | 25 + docs/modules/_types_d_.md | 108 +++ docs/modules/_ws_index_.md | 10 + .../_ws_index_.wsprovider.eventemitter.md | 27 + docs/modules/_ws_polyfill_.md | 2 + 45 files changed, 3010 insertions(+) create mode 100644 docs/api-provider/README.md create mode 100644 docs/api-provider/SUMMARY.md create mode 100644 docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md create mode 100644 docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md create mode 100644 docs/api-provider/modules/_http_index_.md create mode 100644 docs/api-provider/modules/_http_polyfill_.md create mode 100644 docs/api-provider/modules/_index_.md create mode 100644 docs/api-provider/modules/_ws_index_.md create mode 100644 docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md create mode 100644 docs/api-provider/modules/_ws_polyfill_.md create mode 100644 docs/api-rx/README.md create mode 100644 docs/api-rx/SUMMARY.md create mode 100644 docs/api-rx/modules/_defaults_.md create mode 100644 docs/api-rx/modules/_index_.md create mode 100644 docs/api/README.md create mode 100644 docs/api/SUMMARY.md create mode 100644 docs/api/modules/_index_.md create mode 100644 docs/classes/_http_index_.httpprovider.html create mode 100644 docs/classes/_http_index_.httpprovider.md create mode 100644 docs/classes/_ws_index_.wsprovider.html create mode 100644 docs/classes/_ws_index_.wsprovider.md create mode 100644 docs/interfaces/_types_d_.providerinterface.md create mode 100644 docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md create mode 100644 docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md create mode 100644 docs/modules/_coder_json_decoderesponse_.md create mode 100644 docs/modules/_coder_json_encodejson_.md create mode 100644 docs/modules/_coder_json_encodeobject_.md create mode 100644 docs/modules/_coder_json_index_.md create mode 100644 docs/modules/_coder_json_types_d_.md create mode 100644 docs/modules/_http_index_.md create mode 100644 docs/modules/_http_polyfill_.md create mode 100644 docs/modules/_http_types_d_.md create mode 100644 docs/modules/_index_.md create mode 100644 docs/modules/_mock_index_.md create mode 100644 docs/modules/_mock_mocks_.md create mode 100644 docs/modules/_mock_on_.md create mode 100644 docs/modules/_mock_send_.md create mode 100644 docs/modules/_mock_state_.md create mode 100644 docs/modules/_mock_subscribe_.md create mode 100644 docs/modules/_mock_types_d_.md create mode 100644 docs/modules/_mock_unsubscribe_.md create mode 100644 docs/modules/_types_d_.md create mode 100644 docs/modules/_ws_index_.md create mode 100644 docs/modules/_ws_index_.wsprovider.eventemitter.md create mode 100644 docs/modules/_ws_polyfill_.md diff --git a/docs/api-provider/README.md b/docs/api-provider/README.md new file mode 100644 index 000000000000..3c876d13639f --- /dev/null +++ b/docs/api-provider/README.md @@ -0,0 +1,28 @@ + +[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-provider.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-provider) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-provider)](https://david-dm.org/polkadot-js/api?path=packages/api-provider#info=devDependencies) + +@polkadot/api-provider +====================== + +Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces. + +Usage +----- + +Installation - + +``` +npm install --save @polkadot/api-provider +``` + +Initialisation - + +```js +import WsProvider from '@polkadot/api-provider/ws'; + +const provider = new WsProvider('http://127.0.0.1:9944'); +const version = await provider.send('client_version', []); + +console.log('clientVersion', version); +``` + diff --git a/docs/api-provider/SUMMARY.md b/docs/api-provider/SUMMARY.md new file mode 100644 index 000000000000..2b24fb5fc5f7 --- /dev/null +++ b/docs/api-provider/SUMMARY.md @@ -0,0 +1,23 @@ +* ["coder/json/decodeResponse"](modules/_coder_json_decoderesponse_.md) +* ["coder/json/encodeJson"](modules/_coder_json_encodejson_.md) +* ["coder/json/encodeObject"](modules/_coder_json_encodeobject_.md) +* ["coder/json/index"](modules/_coder_json_index_.md) +* ["coder/json/types.d"](modules/_coder_json_types_d_.md) +* ["http/index"](modules/_http_index_.md) + * [HttpProvider](classes/_http_index_.httpprovider.md) +* ["http/polyfill"](modules/_http_polyfill_.md) +* ["http/types.d"](modules/_http_types_d_.md) +* ["index"](modules/_index_.md) +* ["mock/index"](modules/_mock_index_.md) +* ["mock/mocks"](modules/_mock_mocks_.md) +* ["mock/on"](modules/_mock_on_.md) +* ["mock/send"](modules/_mock_send_.md) +* ["mock/state"](modules/_mock_state_.md) +* ["mock/subscribe"](modules/_mock_subscribe_.md) +* ["mock/types.d"](modules/_mock_types_d_.md) +* ["mock/unsubscribe"](modules/_mock_unsubscribe_.md) +* ["types.d"](modules/_types_d_.md) + * [ProviderInterface](interfaces/_types_d_.providerinterface.md) +* ["ws/index"](modules/_ws_index_.md) + * [WsProvider](classes/_ws_index_.wsprovider.md) +* ["ws/polyfill"](modules/_ws_polyfill_.md) diff --git a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md new file mode 100644 index 000000000000..0f983486747f --- /dev/null +++ b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md @@ -0,0 +1,24 @@ + + +# Hierarchy + +**EventEmitterStatic** + +# Constructors + + + +## constructor + +⊕ **new EventEmitterStatic**<`EventTypes`>(): `EventEmitter`<`EventTypes`> + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:57* + +**Type parameters:** + +#### EventTypes : `string` | `symbol` + +**Returns:** `EventEmitter`<`EventTypes`> + +___ + diff --git a/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md new file mode 100644 index 000000000000..a621570ab61d --- /dev/null +++ b/docs/api-provider/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md @@ -0,0 +1,19 @@ + + +# Hierarchy + +**ListenerFn** + +# Callable +▸ **__call**(...args: *`Array`<`any`>*): `void` + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:53* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Rest` args | `Array`<`any`> | + +**Returns:** `void` + diff --git a/docs/api-provider/modules/_http_index_.md b/docs/api-provider/modules/_http_index_.md new file mode 100644 index 000000000000..b670dfa25b70 --- /dev/null +++ b/docs/api-provider/modules/_http_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [HttpProvider](../classes/_http_index_.httpprovider.md) + +--- + diff --git a/docs/api-provider/modules/_http_polyfill_.md b/docs/api-provider/modules/_http_polyfill_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/api-provider/modules/_http_polyfill_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/api-provider/modules/_index_.md b/docs/api-provider/modules/_index_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/api-provider/modules/_index_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/api-provider/modules/_ws_index_.md b/docs/api-provider/modules/_ws_index_.md new file mode 100644 index 000000000000..5849e288b407 --- /dev/null +++ b/docs/api-provider/modules/_ws_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [WsProvider](../classes/_ws_index_.wsprovider.md) + +--- + diff --git a/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md b/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md new file mode 100644 index 000000000000..18004cecc23c --- /dev/null +++ b/docs/api-provider/modules/_ws_index_.wsprovider.eventemitter.md @@ -0,0 +1,27 @@ + + +# Index + +### Interfaces + +* [EventEmitterStatic](../interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md) +* [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) + +### Variables + +* [EventEmitter](_ws_index_.wsprovider.eventemitter.md#eventemitter) + +--- + +# Variables + + + +## `` EventEmitter + +**● EventEmitter**: *`EventEmitterStatic`* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61* + +___ + diff --git a/docs/api-provider/modules/_ws_polyfill_.md b/docs/api-provider/modules/_ws_polyfill_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/api-provider/modules/_ws_polyfill_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/api-rx/README.md b/docs/api-rx/README.md new file mode 100644 index 000000000000..0a560dd8d1f5 --- /dev/null +++ b/docs/api-rx/README.md @@ -0,0 +1,8 @@ + +[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api-rx.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api-rx) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-rx)](https://david-dm.org/polkadot-js/api?path=packages/api-rx#info=devDependencies) + +@polkadot/api-rx +================ + +An RxJs wrapper around the [@polkadot/api](../api). + diff --git a/docs/api-rx/SUMMARY.md b/docs/api-rx/SUMMARY.md new file mode 100644 index 000000000000..4194bf89d2a5 --- /dev/null +++ b/docs/api-rx/SUMMARY.md @@ -0,0 +1,4 @@ +* ["defaults"](modules/_defaults_.md) +* ["index"](modules/_index_.md) + * [RxApi](classes/_index_.rxapi.md) +* ["types.d"](modules/_types_d_.md) diff --git a/docs/api-rx/modules/_defaults_.md b/docs/api-rx/modules/_defaults_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/api-rx/modules/_defaults_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/api-rx/modules/_index_.md b/docs/api-rx/modules/_index_.md new file mode 100644 index 000000000000..bec29894a860 --- /dev/null +++ b/docs/api-rx/modules/_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [RxApi](../classes/_index_.rxapi.md) + +--- + diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 000000000000..45ac535db45e --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,72 @@ + +[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org) ![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square) [![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard) [![npm](https://img.shields.io/npm/v/@polkadot/api.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/api) [![travis](https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square)](https://travis-ci.org/polkadot-js/api) [![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/api/maintainability) [![coverage](https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/api?branch=master) [![dependency](https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api) [![devDependency](https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api)](https://david-dm.org/polkadot-js/api?path=packages/api#info=devDependencies) + +@polkadot/api +============= + +This library provides a clean wrapper around all the methods exposed by a Polkadot network client. + +Usage +----- + +Installation - + +``` +npm install --save @polkadot/api +``` + +Initialisation - + +```js +import Api from '@polkadot/api'; +import WsProvider from '@polkadot/api-provider/ws'; + +const provider = new WsProvider('http://127.0.0.1:9944'); +const api = new Api(provider); +``` + +Making calls - + +```js +api.chain + .getHeader('0x1234567890') + .then((header) => console.log(header)) + .catch((error) => console.error(error)); +``` + +Retrieving the best block (once-off) - + +```js +api.chain + .getHead() + .then((headerHash) => { + return api.chain.getHeader(headerHash); + }) + .then((header) => { + console.log(`best #${header.number.toString()}`); + }) + .catch((error) => { + console.error('error:', error); + }); +``` + +Retrieving best header via subscription - + +```js +api.chain + .newHead((error, header) => { + if (error) { + console.error('error:', error); + } + + console.log(`best #${header.number.toString()}`); + }) + .then((subscriptionId) => { + // id for the subscription, can unsubscribe via + // api.chain.newHead.unsubscribe(subscriptionId) + }) + .catch((error) => { + console.error('error subscribing:', error); + }); +``` + diff --git a/docs/api/SUMMARY.md b/docs/api/SUMMARY.md new file mode 100644 index 000000000000..2ed853f1bfc7 --- /dev/null +++ b/docs/api/SUMMARY.md @@ -0,0 +1,4 @@ +* ["index"](modules/_index_.md) + * [Api](classes/_index_.api.md) +* ["types.d"](modules/_types_d_.md) + * [ApiInterface$Section$Method](interfaces/_types_d_.apiinterface_section_method.md) diff --git a/docs/api/modules/_index_.md b/docs/api/modules/_index_.md new file mode 100644 index 000000000000..7e08da80695e --- /dev/null +++ b/docs/api/modules/_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Api](../classes/_index_.api.md) + +--- + diff --git a/docs/classes/_http_index_.httpprovider.html b/docs/classes/_http_index_.httpprovider.html new file mode 100644 index 000000000000..54ce384eb0e1 --- /dev/null +++ b/docs/classes/_http_index_.httpprovider.html @@ -0,0 +1,623 @@ + + + + + + + HttpProvider · Polkadot API Book + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                +
                + + + + + + + + +
                + +
                + +
                + + + + + + + + +
                +
                + +
                +
                + +
                + +

                name: HttpProvider

                +

                summary: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.

                +

                description: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the WsProvider.

                +

                example:

                +
                import Api from '@polkadot/api';
+import HttpProvider from '@polkadot/api-provider/http';
+
+const provider = new HttpProvider('http://127.0.0.1:9933');
+const api = new Api(provider);
+
                +

                see: WsProvider

                +

                Hierarchy

                +

                HttpProvider

                +

                Implements

                + +

                Constructors

                +

                +

                constructor

                +

                ⊕ new HttpProvider(endpoint: string): HttpProvider

                +

                Defined in http/index.ts:40

                +

                Parameters:

                + + + + + + + + + + + + + + + +
                ParamTypeDescription
                endpointstringThe endpoint url starting with http://
                +

                Returns: HttpProvider

                +
                +

                Methods

                +

                +

                isConnected

                +

                ▸ isConnected(): boolean

                +

                Implementation of ProviderInterface.isConnected

                +

                Defined in http/index.ts:57

                +

                summary: Whether the node is connected or not.

                +

                Returns: boolean +true if connected

                +
                +

                +

                on

                +

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

                +

                Implementation of ProviderInterface.on

                +

                Defined in http/index.ts:65

                +

                summary: Events are not supported with the HttpProvider, see WsProvider.

                +

                description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

                +

                Parameters:

                + + + + + + + + + + + + + + + + + +
                ParamType
                typeProviderInterface$Emitted
                subProviderInterface$EmitCb
                +

                Returns: void

                +
                +

                +

                send

                +

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

                +

                Implementation of ProviderInterface.send

                +

                Defined in http/index.ts:72

                +

                summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

                +

                Parameters:

                + + + + + + + + + + + + + + + + + +
                ParamType
                methodstring
                paramsArray<any>
                +

                Returns: Promise<any>

                +
                +

                +

                subscribe

                +

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

                +

                Implementation of ProviderInterface.subscribe

                +

                Defined in http/index.ts:94

                +

                summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

                +

                Parameters:

                + + + + + + + + + + + + + + + + + + + + + + + + + +
                ParamType
                typesstring
                methodstring
                paramsArray<any>
                cbProviderInterface$Callback
                +

                Returns: Promise<number>

                +
                +

                +

                unsubscribe

                +

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

                +

                Implementation of ProviderInterface.unsubscribe

                +

                Defined in http/index.ts:103

                +

                summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

                +

                Parameters:

                + + + + + + + + + + + + + + + + + + + + + +
                ParamType
                typestring
                methodstring
                idnumber
                +

                Returns: Promise<boolean>

                +
                + + +
                + +
                +
                +
                + +

                results matching ""

                +
                  + +
                  +
                  + +

                  No results matching ""

                  + +
                  +
                  +
                  + +
                  +
                  + +
                  + + + + + + + + + + + + + + +
                  + + +
                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/classes/_http_index_.httpprovider.md b/docs/classes/_http_index_.httpprovider.md new file mode 100644 index 000000000000..a1f6f00ffdf7 --- /dev/null +++ b/docs/classes/_http_index_.httpprovider.md @@ -0,0 +1,159 @@ + + +*__name__*: HttpProvider + +*__summary__*: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port. + +*__description__*: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the [WsProvider](_ws_index_.wsprovider.md). + +*__example__*: +```javascript +import Api from '@polkadot/api'; +import HttpProvider from '@polkadot/api-provider/http'; + +const provider = new HttpProvider('http://127.0.0.1:9933'); +const api = new Api(provider); +``` + +*__see__*: [WsProvider](_ws_index_.wsprovider.md) + +# Hierarchy + +**HttpProvider** + +# Implements + +* [ProviderInterface](../interfaces/_types_d_.providerinterface.md) + +# Constructors + + + +## constructor + +⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md) + +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L40)* + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| endpoint | `string` | The endpoint url starting with http:// | + +**Returns:** [HttpProvider](_http_index_.httpprovider.md) + +___ + +# Methods + + + +## isConnected + +▸ **isConnected**(): `boolean` + +*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)* + +*Defined in [http/index.ts:57](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L57)* + +*__summary__*: Whether the node is connected or not. + +**Returns:** `boolean` +true if connected + +___ + + +## on + +▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` + +*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)* + +*Defined in [http/index.ts:65](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L65)* + +*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). + +*__description__*: HTTP Provider does not have 'on' emitters. WebSockets should be used instead. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | +| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | + +**Returns:** `void` + +___ + + +## send + +▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> + +*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)* + +*Defined in [http/index.ts:72](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L72)* + +*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** `Promise`<`any`> + +___ + + +## subscribe + +▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> + +*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)* + +*Defined in [http/index.ts:94](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L94)* + +*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| types | `string` | +| method | `string` | +| params | `Array`<`any`> | +| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | + +**Returns:** `Promise`<`number`> + +___ + + +## unsubscribe + +▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> + +*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)* + +*Defined in [http/index.ts:103](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L103)* + +*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | +| method | `string` | +| id | `number` | + +**Returns:** `Promise`<`boolean`> + +___ + diff --git a/docs/classes/_ws_index_.wsprovider.html b/docs/classes/_ws_index_.wsprovider.html new file mode 100644 index 000000000000..157965988e00 --- /dev/null +++ b/docs/classes/_ws_index_.wsprovider.html @@ -0,0 +1,904 @@ + + + + + + + WsProvider · Polkadot API Book + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  +
                  + + + + + + + + +
                  + +
                  + +
                  + + + + + + + + +
                  +
                  + +
                  +
                  + +
                  + +

                  name: WsProvider

                  +

                  summary: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.

                  +

                  description: 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';
+import WsProvider from '@polkadot/api-provider/ws';
+
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = new Api(provider);
+
                  +

                  see: HttpProvider

                  +

                  Type parameters

                  +

                  EventTypes : string | symbol

                  +

                  Hierarchy

                  +

                  EventEmitter

                  +

                  ↳ WsProvider

                  +

                  Implements

                  +
                    +
                  • WSProviderInterface
                    • +
                  +

                  Constructors

                  +

                  +

                  constructor

                  +

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

                  +

                  Defined in ws/index.ts:73

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + + + +
                  ParamTypeDefault valueDescription
                  endpointstring-The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`
                  Default value autoConnectbooleantrueWhether to connect automatically or not.
                  +

                  Returns: WsProvider

                  +
                  +

                  Properties

                  +

                  +

                  <Static> prefixed

                  +

                  ● prefixed: string | boolean +

                  +

                  Inherited from EventEmitter.prefixed

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6

                  +
                  +

                  Methods

                  +

                  +

                  addListener

                  +

                  ▸ addListener(event: EventTypes, fn: ListenerFn, context?: any): this

                  +

                  Inherited from EventEmitter.addListener

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  fnListenerFn
                  Optional contextany
                  +

                  Returns: this

                  +
                  +

                  +

                  connect

                  +

                  ▸ connect(): void

                  +

                  Defined in ws/index.ts:104

                  +

                  summary: Manually connect

                  +

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

                  +

                  Returns: void

                  +
                  +

                  +

                  emit

                  +

                  ▸ emit(event: EventTypes, ...args: Array<any>): boolean

                  +

                  Inherited from EventEmitter.emit

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27

                  +

                  Calls each of the listeners registered for a given event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  Rest argsArray<any>
                  +

                  Returns: boolean

                  +
                  +

                  +

                  eventNames

                  +

                  ▸ eventNames(): Array<EventTypes>

                  +

                  Inherited from EventEmitter.eventNames

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12

                  +

                  Return an array listing the events for which the emitter has registered listeners.

                  +

                  Returns: Array<EventTypes>

                  +
                  +

                  +

                  isConnected

                  +

                  ▸ isConnected(): boolean

                  +

                  Defined in ws/index.ts:121

                  +

                  summary: Whether the node is connected or not.

                  +

                  Returns: boolean +true if connected

                  +
                  +

                  +

                  listenerCount

                  +

                  ▸ listenerCount(event: EventTypes): number

                  +

                  Inherited from EventEmitter.listenerCount

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22

                  +

                  Return the number of listeners listening to a given event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  +

                  Returns: number

                  +
                  +

                  +

                  listeners

                  +

                  ▸ listeners(event: EventTypes): Array<ListenerFn>

                  +

                  Inherited from EventEmitter.listeners

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17

                  +

                  Return the listeners registered for a given event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  +

                  Returns: Array<ListenerFn>

                  +
                  +

                  +

                  off

                  +

                  ▸ off(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

                  +

                  Inherited from EventEmitter.off

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  Optional fnListenerFn
                  Optional contextany
                  Optional onceundefined | false | true
                  +

                  Returns: this

                  +
                  +

                  +

                  on

                  +

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

                  +

                  Overrides EventEmitter.on

                  +

                  Defined in ws/index.ts:131

                  +

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

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + +
                  ParamTypeDescription
                  typeProviderInterface$EmittedEvent
                  subProviderInterface$EmitCbCallback
                  +

                  Returns: this +[description]

                  +
                  +

                  +

                  once

                  +

                  ▸ once(event: EventTypes, fn: ListenerFn, context?: any): this

                  +

                  Inherited from EventEmitter.once

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38

                  +

                  Add a one-time listener for a given event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  fnListenerFn
                  Optional contextany
                  +

                  Returns: this

                  +
                  +

                  +

                  removeAllListeners

                  +

                  ▸ removeAllListeners(event?: EventTypes): this

                  +

                  Inherited from EventEmitter.removeAllListeners

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49

                  +

                  Remove all listeners, or those of the specified event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + +
                  ParamType
                  Optional eventEventTypes
                  +

                  Returns: this

                  +
                  +

                  +

                  removeListener

                  +

                  ▸ removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

                  +

                  Inherited from EventEmitter.removeListener

                  +

                  Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43

                  +

                  Remove the listeners of a given event.

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  eventEventTypes
                  Optional fnListenerFn
                  Optional contextany
                  Optional onceundefined | false | true
                  +

                  Returns: this

                  +
                  +

                  +

                  send

                  +

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

                  +

                  Defined in ws/index.ts:138

                  +

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

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  methodstring
                  paramsArray<any>
                  Optional subscriptionSubscriptionHandler
                  +

                  Returns: Promise<any>

                  +
                  +

                  +

                  subscribe

                  +

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

                  +

                  Defined in ws/index.ts:194

                  +

                  name: subscribe

                  +

                  summary: Allows subscribing to a specific event.

                  +

                  example:

                  +
                  const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = new Api(provider);
+
+api.state.storage([[storage.balances.freeBalance, <Address>]], (_, values) => {
+  console.log(values)
+}).then((subscriptionId) => {
+  console.log('balance changes subscription id: ', subscriptionId)
+})
+
                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  ParamTypeDescription
                  typestringSubscription type
                  methodstringSubscription method
                  paramsArray<any>Parameters
                  callbackProviderInterface$CallbackCallback
                  +

                  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/index.ts:203

                  +

                  summary: Allows unsubscribing to subscriptions made with subscribe.

                  +

                  Parameters:

                  + + + + + + + + + + + + + + + + + + + + + +
                  ParamType
                  typestring
                  methodstring
                  idnumber
                  +

                  Returns: Promise<boolean>

                  +
                  + + +
                  + +
                  +
                  +
                  + +

                  results matching ""

                  +
                    + +
                    +
                    + +

                    No results matching ""

                    + +
                    +
                    +
                    + +
                    +
                    + +
                    + + + + + + + + + + + + + + +
                    + + +
                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/classes/_ws_index_.wsprovider.md b/docs/classes/_ws_index_.wsprovider.md new file mode 100644 index 000000000000..ddc210875be8 --- /dev/null +++ b/docs/classes/_ws_index_.wsprovider.md @@ -0,0 +1,392 @@ + + +*__name__*: WsProvider + +*__summary__*: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. + +*__description__*: Unlike the [HttpProvider](_http_index_.httpprovider.md), it does support subscriptions and allows listening to events such as new blocks or balance changes. + +*__example__*: +```javascript +import Api from '@polkadot/api'; +import WsProvider from '@polkadot/api-provider/ws'; + +const provider = new WsProvider('ws://127.0.0.1:9944'); +const api = new Api(provider); +``` + +*__see__*: [HttpProvider](_http_index_.httpprovider.md) + +# Type parameters +#### EventTypes : `string` | `symbol` + +# Hierarchy + + `EventEmitter` + +**↳ WsProvider** + +# Implements + +* `WSProviderInterface` + +# Constructors + + + +## constructor + +⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) + +*Defined in [ws/index.ts:73](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L73)* + +**Parameters:** + +| Param | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| endpoint | `string` | - | 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_index_.wsprovider.md) + +___ + +# Properties + + + +## `` prefixed + +**● prefixed**: * `string` | `boolean` +* + +*Inherited from EventEmitter.prefixed* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6* + +___ + +# Methods + + + +## addListener + +▸ **addListener**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` + +*Inherited from EventEmitter.addListener* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | +| fn | `ListenerFn` | +| `Optional` context | `any` | + +**Returns:** `this` + +___ + + +## connect + +▸ **connect**(): `void` + +*Defined in [ws/index.ts:104](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L104)* + +*__summary__*: Manually connect + +*__description__*: The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default, however if you decided otherwise, you may connect manually using this method. + +**Returns:** `void` + +___ + + +## emit + +▸ **emit**(event: *`EventTypes`*, ...args: *`Array`<`any`>*): `boolean` + +*Inherited from EventEmitter.emit* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27* + +Calls each of the listeners registered for a given event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | +| `Rest` args | `Array`<`any`> | + +**Returns:** `boolean` + +___ + + +## eventNames + +▸ **eventNames**(): `Array`<`EventTypes`> + +*Inherited from EventEmitter.eventNames* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12* + +Return an array listing the events for which the emitter has registered listeners. + +**Returns:** `Array`<`EventTypes`> + +___ + + +## isConnected + +▸ **isConnected**(): `boolean` + +*Defined in [ws/index.ts:121](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L121)* + +*__summary__*: Whether the node is connected or not. + +**Returns:** `boolean` +true if connected + +___ + + +## listenerCount + +▸ **listenerCount**(event: *`EventTypes`*): `number` + +*Inherited from EventEmitter.listenerCount* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22* + +Return the number of listeners listening to a given event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | + +**Returns:** `number` + +___ + + +## listeners + +▸ **listeners**(event: *`EventTypes`*): `Array`<`ListenerFn`> + +*Inherited from EventEmitter.listeners* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17* + +Return the listeners registered for a given event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | + +**Returns:** `Array`<`ListenerFn`> + +___ + + +## off + +▸ **off**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` + +*Inherited from EventEmitter.off* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | +| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | +| `Optional` context | `any` | +| `Optional` once | `undefined` | `false` | `true`| + +**Returns:** `this` + +___ + + +## on + +▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `this` + +*Overrides EventEmitter.on* + +*Defined in [ws/index.ts:131](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L131)* + +*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | Event | +| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | Callback | + +**Returns:** `this` +[description] + +___ + + +## once + +▸ **once**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` + +*Inherited from EventEmitter.once* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38* + +Add a one-time listener for a given event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | +| fn | `ListenerFn` | +| `Optional` context | `any` | + +**Returns:** `this` + +___ + + +## removeAllListeners + +▸ **removeAllListeners**(event?: *[EventTypes]()*): `this` + +*Inherited from EventEmitter.removeAllListeners* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49* + +Remove all listeners, or those of the specified event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` event | [EventTypes]() | + +**Returns:** `this` + +___ + + +## removeListener + +▸ **removeListener**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` + +*Inherited from EventEmitter.removeListener* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43* + +Remove the listeners of a given event. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| event | `EventTypes` | +| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | +| `Optional` context | `any` | +| `Optional` once | `undefined` | `false` | `true`| + +**Returns:** `this` + +___ + + +## send + +▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> + +*Defined in [ws/index.ts:138](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L138)* + +*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| method | `string` | +| params | `Array`<`any`> | +| `Optional` subscription | `SubscriptionHandler` | + +**Returns:** `Promise`<`any`> + +___ + + +## subscribe + +▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> + +*Defined in [ws/index.ts:194](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L194)* + +*__name__*: subscribe + +*__summary__*: Allows subscribing to a specific event. + +*__example__*: +```javascript +const provider = new WsProvider('ws://127.0.0.1:9944'); +const api = new Api(provider); + +api.state.storage([[storage.balances.freeBalance,
                    ]], (_, values) => { + console.log(values) +}).then((subscriptionId) => { + console.log('balance changes subscription id: ', subscriptionId) +}) +``` + +**Parameters:** + +| Param | Type | Description | +| ------ | ------ | ------ | +| type | `string` | Subscription type | +| method | `string` | Subscription method | +| params | `Array`<`any`> | Parameters | +| callback | [ProviderInterface$Callback](../modules/_types_d_.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/index.ts:203](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L203)* + +*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | +| method | `string` | +| id | `number` | + +**Returns:** `Promise`<`boolean`> + +___ + diff --git a/docs/interfaces/_types_d_.providerinterface.md b/docs/interfaces/_types_d_.providerinterface.md new file mode 100644 index 000000000000..2747fe448f57 --- /dev/null +++ b/docs/interfaces/_types_d_.providerinterface.md @@ -0,0 +1,99 @@ + + +# Hierarchy + +**ProviderInterface** + +# Implemented by + +* [HttpProvider](../classes/_http_index_.httpprovider.md) + +# Methods + + + +## isConnected + +▸ **isConnected**(): `boolean` + +*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L45)* + +**Returns:** `boolean` + +___ + + +## on + +▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` + +*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L46)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | +| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | + +**Returns:** `void` + +___ + + +## send + +▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> + +*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L47)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** `Promise`<`any`> + +___ + + +## subscribe + +▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> + +*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L48)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | +| method | `string` | +| params | `Array`<`any`> | +| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | + +**Returns:** `Promise`<`number`> + +___ + + +## unsubscribe + +▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> + +*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L49)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| type | `string` | +| method | `string` | +| id | `number` | + +**Returns:** `Promise`<`boolean`> + +___ + diff --git a/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md b/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md new file mode 100644 index 000000000000..0f983486747f --- /dev/null +++ b/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md @@ -0,0 +1,24 @@ + + +# Hierarchy + +**EventEmitterStatic** + +# Constructors + + + +## constructor + +⊕ **new EventEmitterStatic**<`EventTypes`>(): `EventEmitter`<`EventTypes`> + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:57* + +**Type parameters:** + +#### EventTypes : `string` | `symbol` + +**Returns:** `EventEmitter`<`EventTypes`> + +___ + diff --git a/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md b/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md new file mode 100644 index 000000000000..a621570ab61d --- /dev/null +++ b/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md @@ -0,0 +1,19 @@ + + +# Hierarchy + +**ListenerFn** + +# Callable +▸ **__call**(...args: *`Array`<`any`>*): `void` + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:53* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Rest` args | `Array`<`any`> | + +**Returns:** `void` + diff --git a/docs/modules/_coder_json_decoderesponse_.md b/docs/modules/_coder_json_decoderesponse_.md new file mode 100644 index 000000000000..61c71bfe8b47 --- /dev/null +++ b/docs/modules/_coder_json_decoderesponse_.md @@ -0,0 +1,23 @@ + + +# Functions + + + +## decodeResponse + +▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any` + +*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/decodeResponse.ts#L22)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | +| response | [JsonRpcResponse](_types_d_.md#jsonrpcresponse) | + +**Returns:** `any` + +___ + diff --git a/docs/modules/_coder_json_encodejson_.md b/docs/modules/_coder_json_encodejson_.md new file mode 100644 index 000000000000..af2dd5ced162 --- /dev/null +++ b/docs/modules/_coder_json_encodejson_.md @@ -0,0 +1,24 @@ + + +# Functions + + + +## encodeJson + +▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string` + +*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/encodeJson.ts#L9)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** `string` + +___ + diff --git a/docs/modules/_coder_json_encodeobject_.md b/docs/modules/_coder_json_encodeobject_.md new file mode 100644 index 000000000000..aee19c8d04bf --- /dev/null +++ b/docs/modules/_coder_json_encodeobject_.md @@ -0,0 +1,24 @@ + + +# Functions + + + +## encodeObject + +▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest) + +*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/encodeObject.ts#L8)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** [JsonRpcRequest](_types_d_.md#jsonrpcrequest) + +___ + diff --git a/docs/modules/_coder_json_index_.md b/docs/modules/_coder_json_index_.md new file mode 100644 index 000000000000..8e88245505e8 --- /dev/null +++ b/docs/modules/_coder_json_index_.md @@ -0,0 +1,16 @@ + + +# Functions + + + +## rpcCoder + +▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder) + +*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/index.ts#L12)* + +**Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder) + +___ + diff --git a/docs/modules/_coder_json_types_d_.md b/docs/modules/_coder_json_types_d_.md new file mode 100644 index 000000000000..36b3f41af8ca --- /dev/null +++ b/docs/modules/_coder_json_types_d_.md @@ -0,0 +1,27 @@ + + +# Type aliases + + + +## RpcCoder + +**Ƭ RpcCoder**: *`object`* + +*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/types.d.ts#L7)* + +#### Type declaration + +___ + + +## RpcCoderState + +**Ƭ RpcCoderState**: *`object`* + +*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/types.d.ts#L14)* + +#### Type declaration + +___ + diff --git a/docs/modules/_http_index_.md b/docs/modules/_http_index_.md new file mode 100644 index 000000000000..b670dfa25b70 --- /dev/null +++ b/docs/modules/_http_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [HttpProvider](../classes/_http_index_.httpprovider.md) + +--- + diff --git a/docs/modules/_http_polyfill_.md b/docs/modules/_http_polyfill_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/modules/_http_polyfill_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/modules/_http_types_d_.md b/docs/modules/_http_types_d_.md new file mode 100644 index 000000000000..2f651e0bf357 --- /dev/null +++ b/docs/modules/_http_types_d_.md @@ -0,0 +1,16 @@ + + +# Type aliases + + + +## HttpState + +**Ƭ HttpState**: *`object`* + +*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/types.d.ts#L8)* + +#### Type declaration + +___ + diff --git a/docs/modules/_index_.md b/docs/modules/_index_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/modules/_index_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/modules/_mock_index_.md b/docs/modules/_mock_index_.md new file mode 100644 index 000000000000..5eb170c23e83 --- /dev/null +++ b/docs/modules/_mock_index_.md @@ -0,0 +1,19 @@ + + +# Functions + + + +## mockProvider + +▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md) + +*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/index.ts#L18)* + +A moock provider mainly used for testing. + +**Returns:** [ProviderInterface](../interfaces/_types_d_.providerinterface.md) +The mock provider + +___ + diff --git a/docs/modules/_mock_mocks_.md b/docs/modules/_mock_mocks_.md new file mode 100644 index 000000000000..c1a7b855b410 --- /dev/null +++ b/docs/modules/_mock_mocks_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## mocks + +▸ **mocks**(__namedParameters: *`object`*): `void` + +*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/mocks.ts#L63)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| __namedParameters | `object` | + +**Returns:** `void` + +___ + diff --git a/docs/modules/_mock_on_.md b/docs/modules/_mock_on_.md new file mode 100644 index 000000000000..9ef5265170c3 --- /dev/null +++ b/docs/modules/_mock_on_.md @@ -0,0 +1,24 @@ + + +# Functions + + + +## on + +▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void` + +*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/on.ts#L8)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [MockState](_mock_types_d_.md#mockstate) | +| type | [ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted) | +| sub | [ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb) | + +**Returns:** `void` + +___ + diff --git a/docs/modules/_mock_send_.md b/docs/modules/_mock_send_.md new file mode 100644 index 000000000000..3a02b45d1afb --- /dev/null +++ b/docs/modules/_mock_send_.md @@ -0,0 +1,24 @@ + + +# Functions + + + +## send + +▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> + +*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/send.ts#L7)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| __namedParameters | `object` | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** `Promise`<`any`> + +___ + diff --git a/docs/modules/_mock_state_.md b/docs/modules/_mock_state_.md new file mode 100644 index 000000000000..3de6b1e3ab76 --- /dev/null +++ b/docs/modules/_mock_state_.md @@ -0,0 +1,16 @@ + + +# Functions + + + +## state + +▸ **state**(): [MockState](_mock_types_d_.md#mockstate) + +*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/state.ts#L38)* + +**Returns:** [MockState](_mock_types_d_.md#mockstate) + +___ + diff --git a/docs/modules/_mock_subscribe_.md b/docs/modules/_mock_subscribe_.md new file mode 100644 index 000000000000..41c4d8fb3d59 --- /dev/null +++ b/docs/modules/_mock_subscribe_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## subscribe + +▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`> + +*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/subscribe.ts#L7)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [MockState](_mock_types_d_.md#mockstate) | +| type | `string` | +| method | `string` | +| params | `Array`<`any`> | + +**Returns:** `Promise`<`number`> + +___ + diff --git a/docs/modules/_mock_types_d_.md b/docs/modules/_mock_types_d_.md new file mode 100644 index 000000000000..d3ab13698d80 --- /dev/null +++ b/docs/modules/_mock_types_d_.md @@ -0,0 +1,87 @@ + + +# Type aliases + + + +## MockState + +**Ƭ MockState**: *`object`* + +*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L27)* + +#### Type declaration + +___ + + +## MockState$Db + +**Ƭ MockState$Db**: *`object`* + +*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L19)* + +#### Type declaration + +[index: `string`]: `Uint8Array` + +___ + + +## MockState$Requests + +**Ƭ MockState$Requests**: *`object`* + +*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L23)* + +#### Type declaration + +[index: `string`]: `function` + +▸(db: *[MockState$Db](_mock_types_d_.md#mockstate_db)*, params: *`Array`<`any`>*): `string` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| db | [MockState$Db](_mock_types_d_.md#mockstate_db) | +| params | `Array`<`any`> | + +**Returns:** `string` + +___ + + +## MockState$Subscription$Callback + +**Ƭ MockState$Subscription$Callback**: *`function`* + +*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L8)* + +#### Type declaration +▸(error: * `Error` | `null`*, value: *`any`*): `void` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| error | `Error` | `null`| +| value | `any` | + +**Returns:** `void` + +___ + + +## MockState$Subscriptions + +**Ƭ MockState$Subscriptions**: *`object`* + +*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L10)* + +#### Type declaration + +[index: `string`]: `object` + +___ + diff --git a/docs/modules/_mock_unsubscribe_.md b/docs/modules/_mock_unsubscribe_.md new file mode 100644 index 000000000000..a9ed881818f9 --- /dev/null +++ b/docs/modules/_mock_unsubscribe_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## unsubscribe + +▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`> + +*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/unsubscribe.ts#L7)* + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| self | [MockState](_mock_types_d_.md#mockstate) | +| type | `string` | +| name | `string` | +| id | `number` | + +**Returns:** `Promise`<`boolean`> + +___ + diff --git a/docs/modules/_types_d_.md b/docs/modules/_types_d_.md new file mode 100644 index 000000000000..2c703ae788e9 --- /dev/null +++ b/docs/modules/_types_d_.md @@ -0,0 +1,108 @@ + + +# Type aliases + + + +## JsonRpcObject + +**Ƭ JsonRpcObject**: *`object`* + +*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L5)* + +#### Type declaration + +___ + + +## JsonRpcRequest + +**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object` +* + +*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L10)* + +___ + + +## JsonRpcResponse + +**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase) +* + +*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L36)* + +___ + + +## JsonRpcResponseBase + +**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription` +* + +*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L34)* + +___ + + +## JsonRpcResponseBase$Error + +**Ƭ JsonRpcResponseBase$Error**: *`object`* + +*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L15)* + +#### Type declaration + +___ + + +## ProviderInterface$Callback + +**Ƭ ProviderInterface$Callback**: *`function`* + +*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L38)* + +#### Type declaration +▸(error: * `Error` | `null`*, result: *`any`*): `void` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| error | `Error` | `null`| +| result | `any` | + +**Returns:** `void` + +___ + + +## ProviderInterface$EmitCb + +**Ƭ ProviderInterface$EmitCb**: *`function`* + +*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L42)* + +#### Type declaration +▸(value?: *`any`*): `any` + +**Parameters:** + +| Param | Type | +| ------ | ------ | +| `Optional` value | `any` | + +**Returns:** `any` + +___ + + +## ProviderInterface$Emitted + +**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" +* + +*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L40)* + +___ + diff --git a/docs/modules/_ws_index_.md b/docs/modules/_ws_index_.md new file mode 100644 index 000000000000..5849e288b407 --- /dev/null +++ b/docs/modules/_ws_index_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [WsProvider](../classes/_ws_index_.wsprovider.md) + +--- + diff --git a/docs/modules/_ws_index_.wsprovider.eventemitter.md b/docs/modules/_ws_index_.wsprovider.eventemitter.md new file mode 100644 index 000000000000..18004cecc23c --- /dev/null +++ b/docs/modules/_ws_index_.wsprovider.eventemitter.md @@ -0,0 +1,27 @@ + + +# Index + +### Interfaces + +* [EventEmitterStatic](../interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md) +* [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) + +### Variables + +* [EventEmitter](_ws_index_.wsprovider.eventemitter.md#eventemitter) + +--- + +# Variables + + + +## `` EventEmitter + +**● EventEmitter**: *`EventEmitterStatic`* + +*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61* + +___ + diff --git a/docs/modules/_ws_polyfill_.md b/docs/modules/_ws_polyfill_.md new file mode 100644 index 000000000000..139597f9cb07 --- /dev/null +++ b/docs/modules/_ws_polyfill_.md @@ -0,0 +1,2 @@ + + From ddcd137704223916560b4176379538903cd13d19 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 10 Oct 2018 09:44:26 +0200 Subject: [PATCH 9/9] More... ;) --- docs/classes/_http_index_.httpprovider.html | 623 ------------ docs/classes/_http_index_.httpprovider.md | 159 --- docs/classes/_ws_index_.wsprovider.html | 904 ------------------ docs/classes/_ws_index_.wsprovider.md | 392 -------- .../interfaces/_types_d_.providerinterface.md | 99 -- ...rovider.eventemitter.eventemitterstatic.md | 24 - ...dex_.wsprovider.eventemitter.listenerfn.md | 19 - docs/modules/_coder_json_decoderesponse_.md | 23 - docs/modules/_coder_json_encodejson_.md | 24 - docs/modules/_coder_json_encodeobject_.md | 24 - docs/modules/_coder_json_index_.md | 16 - docs/modules/_coder_json_types_d_.md | 27 - docs/modules/_http_index_.md | 10 - docs/modules/_http_polyfill_.md | 2 - docs/modules/_http_types_d_.md | 16 - docs/modules/_index_.md | 2 - docs/modules/_mock_index_.md | 19 - docs/modules/_mock_mocks_.md | 22 - docs/modules/_mock_on_.md | 24 - docs/modules/_mock_send_.md | 24 - docs/modules/_mock_state_.md | 16 - docs/modules/_mock_subscribe_.md | 25 - docs/modules/_mock_types_d_.md | 87 -- docs/modules/_mock_unsubscribe_.md | 25 - docs/modules/_types_d_.md | 108 --- docs/modules/_ws_index_.md | 10 - .../_ws_index_.wsprovider.eventemitter.md | 27 - docs/modules/_ws_polyfill_.md | 2 - 28 files changed, 2753 deletions(-) delete mode 100644 docs/classes/_http_index_.httpprovider.html delete mode 100644 docs/classes/_http_index_.httpprovider.md delete mode 100644 docs/classes/_ws_index_.wsprovider.html delete mode 100644 docs/classes/_ws_index_.wsprovider.md delete mode 100644 docs/interfaces/_types_d_.providerinterface.md delete mode 100644 docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md delete mode 100644 docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md delete mode 100644 docs/modules/_coder_json_decoderesponse_.md delete mode 100644 docs/modules/_coder_json_encodejson_.md delete mode 100644 docs/modules/_coder_json_encodeobject_.md delete mode 100644 docs/modules/_coder_json_index_.md delete mode 100644 docs/modules/_coder_json_types_d_.md delete mode 100644 docs/modules/_http_index_.md delete mode 100644 docs/modules/_http_polyfill_.md delete mode 100644 docs/modules/_http_types_d_.md delete mode 100644 docs/modules/_index_.md delete mode 100644 docs/modules/_mock_index_.md delete mode 100644 docs/modules/_mock_mocks_.md delete mode 100644 docs/modules/_mock_on_.md delete mode 100644 docs/modules/_mock_send_.md delete mode 100644 docs/modules/_mock_state_.md delete mode 100644 docs/modules/_mock_subscribe_.md delete mode 100644 docs/modules/_mock_types_d_.md delete mode 100644 docs/modules/_mock_unsubscribe_.md delete mode 100644 docs/modules/_types_d_.md delete mode 100644 docs/modules/_ws_index_.md delete mode 100644 docs/modules/_ws_index_.wsprovider.eventemitter.md delete mode 100644 docs/modules/_ws_polyfill_.md diff --git a/docs/classes/_http_index_.httpprovider.html b/docs/classes/_http_index_.httpprovider.html deleted file mode 100644 index 54ce384eb0e1..000000000000 --- a/docs/classes/_http_index_.httpprovider.html +++ /dev/null @@ -1,623 +0,0 @@ - - - - - - - HttpProvider · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    -
                    - - - - - - - - -
                    - -
                    - -
                    - - - - - - - - -
                    -
                    - -
                    -
                    - -
                    - -

                    name: HttpProvider

                    -

                    summary: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.

                    -

                    description: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the WsProvider.

                    -

                    example:

                    -
                    import Api from '@polkadot/api';
-import HttpProvider from '@polkadot/api-provider/http';
-
-const provider = new HttpProvider('http://127.0.0.1:9933');
-const api = new Api(provider);
-
                    -

                    see: WsProvider

                    -

                    Hierarchy

                    -

                    HttpProvider

                    -

                    Implements

                    - -

                    Constructors

                    -

                    -

                    constructor

                    -

                    ⊕ new HttpProvider(endpoint: string): HttpProvider

                    -

                    Defined in http/index.ts:40

                    -

                    Parameters:

                    - - - - - - - - - - - - - - - -
                    ParamTypeDescription
                    endpointstringThe endpoint url starting with http://
                    -

                    Returns: HttpProvider

                    -
                    -

                    Methods

                    -

                    -

                    isConnected

                    -

                    ▸ isConnected(): boolean

                    -

                    Implementation of ProviderInterface.isConnected

                    -

                    Defined in http/index.ts:57

                    -

                    summary: Whether the node is connected or not.

                    -

                    Returns: boolean -true if connected

                    -
                    -

                    -

                    on

                    -

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

                    -

                    Implementation of ProviderInterface.on

                    -

                    Defined in http/index.ts:65

                    -

                    summary: Events are not supported with the HttpProvider, see WsProvider.

                    -

                    description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

                    -

                    Parameters:

                    - - - - - - - - - - - - - - - - - -
                    ParamType
                    typeProviderInterface$Emitted
                    subProviderInterface$EmitCb
                    -

                    Returns: void

                    -
                    -

                    -

                    send

                    -

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

                    -

                    Implementation of ProviderInterface.send

                    -

                    Defined in http/index.ts:72

                    -

                    summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

                    -

                    Parameters:

                    - - - - - - - - - - - - - - - - - -
                    ParamType
                    methodstring
                    paramsArray<any>
                    -

                    Returns: Promise<any>

                    -
                    -

                    -

                    subscribe

                    -

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

                    -

                    Implementation of ProviderInterface.subscribe

                    -

                    Defined in http/index.ts:94

                    -

                    summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

                    -

                    Parameters:

                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    ParamType
                    typesstring
                    methodstring
                    paramsArray<any>
                    cbProviderInterface$Callback
                    -

                    Returns: Promise<number>

                    -
                    -

                    -

                    unsubscribe

                    -

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

                    -

                    Implementation of ProviderInterface.unsubscribe

                    -

                    Defined in http/index.ts:103

                    -

                    summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

                    -

                    Parameters:

                    - - - - - - - - - - - - - - - - - - - - - -
                    ParamType
                    typestring
                    methodstring
                    idnumber
                    -

                    Returns: Promise<boolean>

                    -
                    - - -
                    - -
                    -
                    -
                    - -

                    results matching ""

                    -
                      - -
                      -
                      - -

                      No results matching ""

                      - -
                      -
                      -
                      - -
                      -
                      - -
                      - - - - - - - - - - - - - - -
                      - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/_http_index_.httpprovider.md b/docs/classes/_http_index_.httpprovider.md deleted file mode 100644 index a1f6f00ffdf7..000000000000 --- a/docs/classes/_http_index_.httpprovider.md +++ /dev/null @@ -1,159 +0,0 @@ - - -*__name__*: HttpProvider - -*__summary__*: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port. - -*__description__*: It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferrable using the [WsProvider](_ws_index_.wsprovider.md). - -*__example__*: -```javascript -import Api from '@polkadot/api'; -import HttpProvider from '@polkadot/api-provider/http'; - -const provider = new HttpProvider('http://127.0.0.1:9933'); -const api = new Api(provider); -``` - -*__see__*: [WsProvider](_ws_index_.wsprovider.md) - -# Hierarchy - -**HttpProvider** - -# Implements - -* [ProviderInterface](../interfaces/_types_d_.providerinterface.md) - -# Constructors - - - -## constructor - -⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md) - -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L40)* - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| endpoint | `string` | The endpoint url starting with http:// | - -**Returns:** [HttpProvider](_http_index_.httpprovider.md) - -___ - -# Methods - - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)* - -*Defined in [http/index.ts:57](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L57)* - -*__summary__*: Whether the node is connected or not. - -**Returns:** `boolean` -true if connected - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)* - -*Defined in [http/index.ts:65](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L65)* - -*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -*__description__*: HTTP Provider does not have 'on' emitters. WebSockets should be used instead. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)* - -*Defined in [http/index.ts:72](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L72)* - -*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)* - -*Defined in [http/index.ts:94](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L94)* - -*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| types | `string` | -| method | `string` | -| params | `Array`<`any`> | -| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | - -**Returns:** `Promise`<`number`> - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)* - -*Defined in [http/index.ts:103](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/index.ts#L103)* - -*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/classes/_ws_index_.wsprovider.html b/docs/classes/_ws_index_.wsprovider.html deleted file mode 100644 index 157965988e00..000000000000 --- a/docs/classes/_ws_index_.wsprovider.html +++ /dev/null @@ -1,904 +0,0 @@ - - - - - - - WsProvider · Polkadot API Book - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      -
                      - - - - - - - - -
                      - -
                      - -
                      - - - - - - - - -
                      -
                      - -
                      -
                      - -
                      - -

                      name: WsProvider

                      -

                      summary: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.

                      -

                      description: 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';
-import WsProvider from '@polkadot/api-provider/ws';
-
-const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
                      -

                      see: HttpProvider

                      -

                      Type parameters

                      -

                      EventTypes : string | symbol

                      -

                      Hierarchy

                      -

                      EventEmitter

                      -

                      ↳ WsProvider

                      -

                      Implements

                      -
                        -
                      • WSProviderInterface
                        • -
                      -

                      Constructors

                      -

                      -

                      constructor

                      -

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

                      -

                      Defined in ws/index.ts:73

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - - - -
                      ParamTypeDefault valueDescription
                      endpointstring-The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`
                      Default value autoConnectbooleantrueWhether to connect automatically or not.
                      -

                      Returns: WsProvider

                      -
                      -

                      Properties

                      -

                      -

                      <Static> prefixed

                      -

                      ● prefixed: string | boolean -

                      -

                      Inherited from EventEmitter.prefixed

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6

                      -
                      -

                      Methods

                      -

                      -

                      addListener

                      -

                      ▸ addListener(event: EventTypes, fn: ListenerFn, context?: any): this

                      -

                      Inherited from EventEmitter.addListener

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      fnListenerFn
                      Optional contextany
                      -

                      Returns: this

                      -
                      -

                      -

                      connect

                      -

                      ▸ connect(): void

                      -

                      Defined in ws/index.ts:104

                      -

                      summary: Manually connect

                      -

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

                      -

                      Returns: void

                      -
                      -

                      -

                      emit

                      -

                      ▸ emit(event: EventTypes, ...args: Array<any>): boolean

                      -

                      Inherited from EventEmitter.emit

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27

                      -

                      Calls each of the listeners registered for a given event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      Rest argsArray<any>
                      -

                      Returns: boolean

                      -
                      -

                      -

                      eventNames

                      -

                      ▸ eventNames(): Array<EventTypes>

                      -

                      Inherited from EventEmitter.eventNames

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12

                      -

                      Return an array listing the events for which the emitter has registered listeners.

                      -

                      Returns: Array<EventTypes>

                      -
                      -

                      -

                      isConnected

                      -

                      ▸ isConnected(): boolean

                      -

                      Defined in ws/index.ts:121

                      -

                      summary: Whether the node is connected or not.

                      -

                      Returns: boolean -true if connected

                      -
                      -

                      -

                      listenerCount

                      -

                      ▸ listenerCount(event: EventTypes): number

                      -

                      Inherited from EventEmitter.listenerCount

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22

                      -

                      Return the number of listeners listening to a given event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      -

                      Returns: number

                      -
                      -

                      -

                      listeners

                      -

                      ▸ listeners(event: EventTypes): Array<ListenerFn>

                      -

                      Inherited from EventEmitter.listeners

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17

                      -

                      Return the listeners registered for a given event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      -

                      Returns: Array<ListenerFn>

                      -
                      -

                      -

                      off

                      -

                      ▸ off(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

                      -

                      Inherited from EventEmitter.off

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      Optional fnListenerFn
                      Optional contextany
                      Optional onceundefined | false | true
                      -

                      Returns: this

                      -
                      -

                      -

                      on

                      -

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

                      -

                      Overrides EventEmitter.on

                      -

                      Defined in ws/index.ts:131

                      -

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

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - -
                      ParamTypeDescription
                      typeProviderInterface$EmittedEvent
                      subProviderInterface$EmitCbCallback
                      -

                      Returns: this -[description]

                      -
                      -

                      -

                      once

                      -

                      ▸ once(event: EventTypes, fn: ListenerFn, context?: any): this

                      -

                      Inherited from EventEmitter.once

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38

                      -

                      Add a one-time listener for a given event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      fnListenerFn
                      Optional contextany
                      -

                      Returns: this

                      -
                      -

                      -

                      removeAllListeners

                      -

                      ▸ removeAllListeners(event?: EventTypes): this

                      -

                      Inherited from EventEmitter.removeAllListeners

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49

                      -

                      Remove all listeners, or those of the specified event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - -
                      ParamType
                      Optional eventEventTypes
                      -

                      Returns: this

                      -
                      -

                      -

                      removeListener

                      -

                      ▸ removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this

                      -

                      Inherited from EventEmitter.removeListener

                      -

                      Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43

                      -

                      Remove the listeners of a given event.

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      eventEventTypes
                      Optional fnListenerFn
                      Optional contextany
                      Optional onceundefined | false | true
                      -

                      Returns: this

                      -
                      -

                      -

                      send

                      -

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

                      -

                      Defined in ws/index.ts:138

                      -

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

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      methodstring
                      paramsArray<any>
                      Optional subscriptionSubscriptionHandler
                      -

                      Returns: Promise<any>

                      -
                      -

                      -

                      subscribe

                      -

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

                      -

                      Defined in ws/index.ts:194

                      -

                      name: subscribe

                      -

                      summary: Allows subscribing to a specific event.

                      -

                      example:

                      -
                      const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
-api.state.storage([[storage.balances.freeBalance, <Address>]], (_, values) => {
-  console.log(values)
-}).then((subscriptionId) => {
-  console.log('balance changes subscription id: ', subscriptionId)
-})
-
                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      ParamTypeDescription
                      typestringSubscription type
                      methodstringSubscription method
                      paramsArray<any>Parameters
                      callbackProviderInterface$CallbackCallback
                      -

                      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/index.ts:203

                      -

                      summary: Allows unsubscribing to subscriptions made with subscribe.

                      -

                      Parameters:

                      - - - - - - - - - - - - - - - - - - - - - -
                      ParamType
                      typestring
                      methodstring
                      idnumber
                      -

                      Returns: Promise<boolean>

                      -
                      - - -
                      - -
                      -
                      -
                      - -

                      results matching ""

                      -
                        - -
                        -
                        - -

                        No results matching ""

                        - -
                        -
                        -
                        - -
                        -
                        - -
                        - - - - - - - - - - - - - - -
                        - - -
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/_ws_index_.wsprovider.md b/docs/classes/_ws_index_.wsprovider.md deleted file mode 100644 index ddc210875be8..000000000000 --- a/docs/classes/_ws_index_.wsprovider.md +++ /dev/null @@ -1,392 +0,0 @@ - - -*__name__*: WsProvider - -*__summary__*: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. - -*__description__*: Unlike the [HttpProvider](_http_index_.httpprovider.md), it does support subscriptions and allows listening to events such as new blocks or balance changes. - -*__example__*: -```javascript -import Api from '@polkadot/api'; -import WsProvider from '@polkadot/api-provider/ws'; - -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); -``` - -*__see__*: [HttpProvider](_http_index_.httpprovider.md) - -# Type parameters -#### EventTypes : `string` | `symbol` - -# Hierarchy - - `EventEmitter` - -**↳ WsProvider** - -# Implements - -* `WSProviderInterface` - -# Constructors - - - -## constructor - -⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) - -*Defined in [ws/index.ts:73](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L73)* - -**Parameters:** - -| Param | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| endpoint | `string` | - | 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_index_.wsprovider.md) - -___ - -# Properties - - - -## `` prefixed - -**● prefixed**: * `string` | `boolean` -* - -*Inherited from EventEmitter.prefixed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6* - -___ - -# Methods - - - -## addListener - -▸ **addListener**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` - -*Inherited from EventEmitter.addListener* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| fn | `ListenerFn` | -| `Optional` context | `any` | - -**Returns:** `this` - -___ - - -## connect - -▸ **connect**(): `void` - -*Defined in [ws/index.ts:104](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L104)* - -*__summary__*: Manually connect - -*__description__*: The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default, however if you decided otherwise, you may connect manually using this method. - -**Returns:** `void` - -___ - - -## emit - -▸ **emit**(event: *`EventTypes`*, ...args: *`Array`<`any`>*): `boolean` - -*Inherited from EventEmitter.emit* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27* - -Calls each of the listeners registered for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Rest` args | `Array`<`any`> | - -**Returns:** `boolean` - -___ - - -## eventNames - -▸ **eventNames**(): `Array`<`EventTypes`> - -*Inherited from EventEmitter.eventNames* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12* - -Return an array listing the events for which the emitter has registered listeners. - -**Returns:** `Array`<`EventTypes`> - -___ - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [ws/index.ts:121](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L121)* - -*__summary__*: Whether the node is connected or not. - -**Returns:** `boolean` -true if connected - -___ - - -## listenerCount - -▸ **listenerCount**(event: *`EventTypes`*): `number` - -*Inherited from EventEmitter.listenerCount* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22* - -Return the number of listeners listening to a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | - -**Returns:** `number` - -___ - - -## listeners - -▸ **listeners**(event: *`EventTypes`*): `Array`<`ListenerFn`> - -*Inherited from EventEmitter.listeners* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17* - -Return the listeners registered for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | - -**Returns:** `Array`<`ListenerFn`> - -___ - - -## off - -▸ **off**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` - -*Inherited from EventEmitter.off* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | -| `Optional` context | `any` | -| `Optional` once | `undefined` | `false` | `true`| - -**Returns:** `this` - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `this` - -*Overrides EventEmitter.on* - -*Defined in [ws/index.ts:131](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L131)* - -*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | Event | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | Callback | - -**Returns:** `this` -[description] - -___ - - -## once - -▸ **once**(event: *`EventTypes`*, fn: *`ListenerFn`*, context?: *`any`*): `this` - -*Inherited from EventEmitter.once* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38* - -Add a one-time listener for a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| fn | `ListenerFn` | -| `Optional` context | `any` | - -**Returns:** `this` - -___ - - -## removeAllListeners - -▸ **removeAllListeners**(event?: *[EventTypes]()*): `this` - -*Inherited from EventEmitter.removeAllListeners* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49* - -Remove all listeners, or those of the specified event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` event | [EventTypes]() | - -**Returns:** `this` - -___ - - -## removeListener - -▸ **removeListener**(event: *`EventTypes`*, fn?: *[ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md)*, context?: *`any`*, once?: * `undefined` | `false` | `true`*): `this` - -*Inherited from EventEmitter.removeListener* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43* - -Remove the listeners of a given event. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| event | `EventTypes` | -| `Optional` fn | [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) | -| `Optional` context | `any` | -| `Optional` once | `undefined` | `false` | `true`| - -**Returns:** `this` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> - -*Defined in [ws/index.ts:138](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L138)* - -*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | -| `Optional` subscription | `SubscriptionHandler` | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [ws/index.ts:194](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L194)* - -*__name__*: subscribe - -*__summary__*: Allows subscribing to a specific event. - -*__example__*: -```javascript -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); - -api.state.storage([[storage.balances.freeBalance,
                        ]], (_, values) => { - console.log(values) -}).then((subscriptionId) => { - console.log('balance changes subscription id: ', subscriptionId) -}) -``` - -**Parameters:** - -| Param | Type | Description | -| ------ | ------ | ------ | -| type | `string` | Subscription type | -| method | `string` | Subscription method | -| params | `Array`<`any`> | Parameters | -| callback | [ProviderInterface$Callback](../modules/_types_d_.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/index.ts:203](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/ws/index.ts#L203)* - -*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/interfaces/_types_d_.providerinterface.md b/docs/interfaces/_types_d_.providerinterface.md deleted file mode 100644 index 2747fe448f57..000000000000 --- a/docs/interfaces/_types_d_.providerinterface.md +++ /dev/null @@ -1,99 +0,0 @@ - - -# Hierarchy - -**ProviderInterface** - -# Implemented by - -* [HttpProvider](../classes/_http_index_.httpprovider.md) - -# Methods - - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L45)* - -**Returns:** `boolean` - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void` - -*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L46)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L47)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L48)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| params | `Array`<`any`> | -| cb | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | - -**Returns:** `Promise`<`number`> - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L49)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md b/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md deleted file mode 100644 index 0f983486747f..000000000000 --- a/docs/interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Hierarchy - -**EventEmitterStatic** - -# Constructors - - - -## constructor - -⊕ **new EventEmitterStatic**<`EventTypes`>(): `EventEmitter`<`EventTypes`> - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:57* - -**Type parameters:** - -#### EventTypes : `string` | `symbol` - -**Returns:** `EventEmitter`<`EventTypes`> - -___ - diff --git a/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md b/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md deleted file mode 100644 index a621570ab61d..000000000000 --- a/docs/interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Hierarchy - -**ListenerFn** - -# Callable -▸ **__call**(...args: *`Array`<`any`>*): `void` - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:53* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Rest` args | `Array`<`any`> | - -**Returns:** `void` - diff --git a/docs/modules/_coder_json_decoderesponse_.md b/docs/modules/_coder_json_decoderesponse_.md deleted file mode 100644 index 61c71bfe8b47..000000000000 --- a/docs/modules/_coder_json_decoderesponse_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Functions - - - -## decodeResponse - -▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any` - -*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/decodeResponse.ts#L22)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| response | [JsonRpcResponse](_types_d_.md#jsonrpcresponse) | - -**Returns:** `any` - -___ - diff --git a/docs/modules/_coder_json_encodejson_.md b/docs/modules/_coder_json_encodejson_.md deleted file mode 100644 index af2dd5ced162..000000000000 --- a/docs/modules/_coder_json_encodejson_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## encodeJson - -▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string` - -*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/encodeJson.ts#L9)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `string` - -___ - diff --git a/docs/modules/_coder_json_encodeobject_.md b/docs/modules/_coder_json_encodeobject_.md deleted file mode 100644 index aee19c8d04bf..000000000000 --- a/docs/modules/_coder_json_encodeobject_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## encodeObject - -▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest) - -*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/encodeObject.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [RpcCoderState](_coder_json_types_d_.md#rpccoderstate) | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** [JsonRpcRequest](_types_d_.md#jsonrpcrequest) - -___ - diff --git a/docs/modules/_coder_json_index_.md b/docs/modules/_coder_json_index_.md deleted file mode 100644 index 8e88245505e8..000000000000 --- a/docs/modules/_coder_json_index_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Functions - - - -## rpcCoder - -▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder) - -*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/index.ts#L12)* - -**Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder) - -___ - diff --git a/docs/modules/_coder_json_types_d_.md b/docs/modules/_coder_json_types_d_.md deleted file mode 100644 index 36b3f41af8ca..000000000000 --- a/docs/modules/_coder_json_types_d_.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Type aliases - - - -## RpcCoder - -**Ƭ RpcCoder**: *`object`* - -*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/types.d.ts#L7)* - -#### Type declaration - -___ - - -## RpcCoderState - -**Ƭ RpcCoderState**: *`object`* - -*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/coder/json/types.d.ts#L14)* - -#### Type declaration - -___ - diff --git a/docs/modules/_http_index_.md b/docs/modules/_http_index_.md deleted file mode 100644 index b670dfa25b70..000000000000 --- a/docs/modules/_http_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [HttpProvider](../classes/_http_index_.httpprovider.md) - ---- - diff --git a/docs/modules/_http_polyfill_.md b/docs/modules/_http_polyfill_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/modules/_http_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/modules/_http_types_d_.md b/docs/modules/_http_types_d_.md deleted file mode 100644 index 2f651e0bf357..000000000000 --- a/docs/modules/_http_types_d_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Type aliases - - - -## HttpState - -**Ƭ HttpState**: *`object`* - -*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/http/types.d.ts#L8)* - -#### Type declaration - -___ - diff --git a/docs/modules/_index_.md b/docs/modules/_index_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/modules/_index_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/modules/_mock_index_.md b/docs/modules/_mock_index_.md deleted file mode 100644 index 5eb170c23e83..000000000000 --- a/docs/modules/_mock_index_.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Functions - - - -## mockProvider - -▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md) - -*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/index.ts#L18)* - -A moock provider mainly used for testing. - -**Returns:** [ProviderInterface](../interfaces/_types_d_.providerinterface.md) -The mock provider - -___ - diff --git a/docs/modules/_mock_mocks_.md b/docs/modules/_mock_mocks_.md deleted file mode 100644 index c1a7b855b410..000000000000 --- a/docs/modules/_mock_mocks_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## mocks - -▸ **mocks**(__namedParameters: *`object`*): `void` - -*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/mocks.ts#L63)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | - -**Returns:** `void` - -___ - diff --git a/docs/modules/_mock_on_.md b/docs/modules/_mock_on_.md deleted file mode 100644 index 9ef5265170c3..000000000000 --- a/docs/modules/_mock_on_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## on - -▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void` - -*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/on.ts#L8)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | [ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - diff --git a/docs/modules/_mock_send_.md b/docs/modules/_mock_send_.md deleted file mode 100644 index 3a02b45d1afb..000000000000 --- a/docs/modules/_mock_send_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## send - -▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/send.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| __namedParameters | `object` | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - diff --git a/docs/modules/_mock_state_.md b/docs/modules/_mock_state_.md deleted file mode 100644 index 3de6b1e3ab76..000000000000 --- a/docs/modules/_mock_state_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Functions - - - -## state - -▸ **state**(): [MockState](_mock_types_d_.md#mockstate) - -*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/state.ts#L38)* - -**Returns:** [MockState](_mock_types_d_.md#mockstate) - -___ - diff --git a/docs/modules/_mock_subscribe_.md b/docs/modules/_mock_subscribe_.md deleted file mode 100644 index 41c4d8fb3d59..000000000000 --- a/docs/modules/_mock_subscribe_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## subscribe - -▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`> - -*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/subscribe.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | `string` | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`number`> - -___ - diff --git a/docs/modules/_mock_types_d_.md b/docs/modules/_mock_types_d_.md deleted file mode 100644 index d3ab13698d80..000000000000 --- a/docs/modules/_mock_types_d_.md +++ /dev/null @@ -1,87 +0,0 @@ - - -# Type aliases - - - -## MockState - -**Ƭ MockState**: *`object`* - -*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L27)* - -#### Type declaration - -___ - - -## MockState$Db - -**Ƭ MockState$Db**: *`object`* - -*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L19)* - -#### Type declaration - -[index: `string`]: `Uint8Array` - -___ - - -## MockState$Requests - -**Ƭ MockState$Requests**: *`object`* - -*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L23)* - -#### Type declaration - -[index: `string`]: `function` - -▸(db: *[MockState$Db](_mock_types_d_.md#mockstate_db)*, params: *`Array`<`any`>*): `string` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| db | [MockState$Db](_mock_types_d_.md#mockstate_db) | -| params | `Array`<`any`> | - -**Returns:** `string` - -___ - - -## MockState$Subscription$Callback - -**Ƭ MockState$Subscription$Callback**: *`function`* - -*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L8)* - -#### Type declaration -▸(error: * `Error` | `null`*, value: *`any`*): `void` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| error | `Error` | `null`| -| value | `any` | - -**Returns:** `void` - -___ - - -## MockState$Subscriptions - -**Ƭ MockState$Subscriptions**: *`object`* - -*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/types.d.ts#L10)* - -#### Type declaration - -[index: `string`]: `object` - -___ - diff --git a/docs/modules/_mock_unsubscribe_.md b/docs/modules/_mock_unsubscribe_.md deleted file mode 100644 index a9ed881818f9..000000000000 --- a/docs/modules/_mock_unsubscribe_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## unsubscribe - -▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/mock/unsubscribe.ts#L7)* - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| self | [MockState](_mock_types_d_.md#mockstate) | -| type | `string` | -| name | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/modules/_types_d_.md b/docs/modules/_types_d_.md deleted file mode 100644 index 2c703ae788e9..000000000000 --- a/docs/modules/_types_d_.md +++ /dev/null @@ -1,108 +0,0 @@ - - -# Type aliases - - - -## JsonRpcObject - -**Ƭ JsonRpcObject**: *`object`* - -*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L5)* - -#### Type declaration - -___ - - -## JsonRpcRequest - -**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object` -* - -*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L10)* - -___ - - -## JsonRpcResponse - -**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase) -* - -*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L36)* - -___ - - -## JsonRpcResponseBase - -**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription` -* - -*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L34)* - -___ - - -## JsonRpcResponseBase$Error - -**Ƭ JsonRpcResponseBase$Error**: *`object`* - -*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L15)* - -#### Type declaration - -___ - - -## ProviderInterface$Callback - -**Ƭ ProviderInterface$Callback**: *`function`* - -*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L38)* - -#### Type declaration -▸(error: * `Error` | `null`*, result: *`any`*): `void` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| error | `Error` | `null`| -| result | `any` | - -**Returns:** `void` - -___ - - -## ProviderInterface$EmitCb - -**Ƭ ProviderInterface$EmitCb**: *`function`* - -*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L42)* - -#### Type declaration -▸(value?: *`any`*): `any` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** `any` - -___ - - -## ProviderInterface$Emitted - -**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" -* - -*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/7f270cb/packages/api-provider/src/types.d.ts#L40)* - -___ - diff --git a/docs/modules/_ws_index_.md b/docs/modules/_ws_index_.md deleted file mode 100644 index 5849e288b407..000000000000 --- a/docs/modules/_ws_index_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [WsProvider](../classes/_ws_index_.wsprovider.md) - ---- - diff --git a/docs/modules/_ws_index_.wsprovider.eventemitter.md b/docs/modules/_ws_index_.wsprovider.eventemitter.md deleted file mode 100644 index 18004cecc23c..000000000000 --- a/docs/modules/_ws_index_.wsprovider.eventemitter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Index - -### Interfaces - -* [EventEmitterStatic](../interfaces/_ws_index_.wsprovider.eventemitter.eventemitterstatic.md) -* [ListenerFn](../interfaces/_ws_index_.wsprovider.eventemitter.listenerfn.md) - -### Variables - -* [EventEmitter](_ws_index_.wsprovider.eventemitter.md#eventemitter) - ---- - -# Variables - - - -## `` EventEmitter - -**● EventEmitter**: *`EventEmitterStatic`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61* - -___ - diff --git a/docs/modules/_ws_polyfill_.md b/docs/modules/_ws_polyfill_.md deleted file mode 100644 index 139597f9cb07..000000000000 --- a/docs/modules/_ws_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - -