From 79df0047c7ca9865018ff269ccf06515b614204f Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Wed, 13 Feb 2019 09:09:26 +0000 Subject: [PATCH] [CI Skip] 0.42.15 --- docs/GLOSSARY.html | 2 +- docs/METHODS_EVENTS.html | 2 +- docs/METHODS_EXTRINSICS.html | 2 +- docs/METHODS_RPC.html | 2 +- docs/METHODS_STORAGE.html | 2 +- ..._referenduminfo_.referenduminfoextended.md | 34 +++++------ docs/api-derive/interfaces/_index_.derive.md | 12 ++-- .../modules/_accounts_idandindex_.md | 4 +- .../modules/_accounts_idtoindex_.md | 2 +- docs/api-derive/modules/_accounts_indexes_.md | 4 +- .../modules/_accounts_indextoid_.md | 2 +- docs/api-derive/modules/_balances_fees_.md | 2 +- .../modules/_balances_validatingbalance_.md | 2 +- .../modules/_balances_validatingbalances_.md | 2 +- .../modules/_balances_votingbalance_.md | 2 +- .../modules/_balances_votingbalances_.md | 2 +- .../_balances_votingbalancesnominatorsfor_.md | 2 +- docs/api-derive/modules/_chain_bestnumber_.md | 2 +- .../modules/_chain_bestnumberfinalised_.md | 2 +- .../modules/_chain_bestnumberlag_.md | 2 +- docs/api-derive/modules/_chain_getheader_.md | 2 +- .../modules/_chain_subscribenewhead_.md | 4 +- .../modules/_democracy_referenduminfo_.md | 2 +- .../modules/_democracy_referenduminfos_.md | 2 +- .../modules/_democracy_referendums_.md | 2 +- .../modules/_democracy_referendumvotesfor_.md | 2 +- docs/api-derive/modules/_democracy_votes_.md | 2 +- docs/api-derive/modules/_index_.md | 2 +- .../api-derive/modules/_session_eralength_.md | 2 +- .../modules/_session_eraprogress_.md | 2 +- .../modules/_session_sessionprogress_.md | 2 +- .../modules/_staking_intentionsbalances_.md | 2 +- docs/api-derive/modules/_types_.md | 8 +-- docs/api-derive/modules/_util_cache_.md | 2 +- docs/api/classes/_base_.apibase.md | 30 +++++----- .../_promise_combinator_.combinator.md | 4 +- .../classes/_promise_index_.apipromise.html | 40 ++++++------- .../api/classes/_promise_index_.apipromise.md | 38 ++++++------- docs/api/classes/_rx_index_.apirx.html | 40 ++++++------- docs/api/classes/_rx_index_.apirx.md | 38 ++++++------- ...mittableextrinsic_.submittableextrinsic.md | 56 +++++++++---------- ...submittableextrinsic_.submittableresult.md | 30 +++++----- docs/api/index.html | 2 +- .../_promise_types_.apipromiseinterface.md | 32 +++++------ .../interfaces/_rx_types_.apirxinterface.md | 34 +++++------ .../interfaces/_types_.apibaseinterface.md | 6 +- .../_types_.apiinterface_decorated.md | 18 +++--- docs/api/interfaces/_types_.apioptions.md | 8 +-- docs/api/interfaces/_types_.decoratedrpc.md | 8 +-- .../interfaces/_types_.decoratedrpc_method.md | 6 +- .../_types_.queryablestoragefunctionbase.md | 20 +++---- docs/api/interfaces/_types_.signer.md | 4 +- .../_types_.submittableextrinsicfunction.md | 14 ++--- docs/api/modules/_promise_combinator_.md | 4 +- docs/api/modules/_promise_types_.md | 10 ++-- docs/api/modules/_rx_types_.md | 2 +- docs/api/modules/_types_.md | 18 +++--- docs/api/modules/_util_filterevents_.md | 2 +- .../promise/01_simple_connect/index.html | 2 +- .../promise/02_listen_to_blocks/index.html | 2 +- .../03_listen_to_balance_change/index.html | 2 +- .../promise/04_unsubscribe/index.html | 2 +- .../promise/05_read_storage/index.html | 2 +- .../promise/06_make_transfer/index.html | 2 +- .../promise/08_system_events/index.html | 2 +- .../promise/09_transfer_events/index.html | 2 +- .../promise/10_upgrade_chain/index.html | 2 +- docs/examples/promise/index.html | 2 +- docs/examples/rx/01_simple_connect/index.html | 2 +- .../rx/02_listen_to_blocks/index.html | 2 +- .../rx/03_listen_to_balance_change/index.html | 2 +- docs/examples/rx/04_unsubscribe/index.html | 2 +- docs/examples/rx/05_read_storage/index.html | 2 +- docs/examples/rx/06_make_transfer/index.html | 2 +- docs/examples/rx/08_system_events/index.html | 2 +- .../examples/rx/09_transfer_events/index.html | 2 +- docs/examples/rx/10_upgrade_chain/index.html | 2 +- docs/examples/rx/index.html | 2 +- docs/index.html | 2 +- docs/rpc-core/classes/_index_.rpc.md | 16 +++--- .../interfaces/_types_.rpcinterface.md | 8 +-- .../interfaces/_types_.rpcinterface_method.md | 6 +- docs/rpc-core/modules/_types_.md | 2 +- .../classes/_coder_index_.rpccoder.md | 8 +-- .../classes/_http_index_.httpprovider.html | 20 +++---- .../classes/_http_index_.httpprovider.md | 18 +++--- .../rpc-provider/classes/_mock_index_.mock.md | 22 ++++---- .../classes/_ws_index_.wsprovider.html | 22 ++++---- .../classes/_ws_index_.wsprovider.md | 20 +++---- docs/rpc-provider/index.html | 2 +- .../interfaces/_types_.providerinterface.md | 16 +++--- docs/rpc-provider/modules/_http_types_.md | 2 +- docs/rpc-provider/modules/_mock_types_.md | 8 +-- docs/rpc-provider/modules/_types_.md | 16 +++--- docs/rpc-rx/classes/_index_.rpcrx.md | 14 ++--- docs/rpc-rx/modules/_types_.md | 8 +-- .../type-extrinsics/modules/_frommetadata_.md | 2 +- .../modules/_utils_createunchecked_.md | 2 +- docs/type-jsonrpc/modules/_create_method_.md | 2 +- docs/type-jsonrpc/modules/_create_param_.md | 2 +- docs/type-jsonrpc/modules/_types_.md | 8 +-- .../interfaces/_types_.storage.md | 2 +- ...utils_createfunction_.createitemoptions.md | 4 +- docs/type-storage/modules/_frommetadata_.md | 2 +- docs/type-storage/modules/_storage_.md | 4 +- docs/type-storage/modules/_substrate_.md | 12 ++-- .../modules/_utils_createfunction_.md | 2 +- docs/types/classes/_accountid_.accountid.html | 26 ++++----- docs/types/classes/_accountid_.accountid.md | 24 ++++---- .../classes/_accountidof_.accountidof.md | 24 ++++---- .../classes/_accountindex_.accountindex.html | 22 ++++---- .../classes/_accountindex_.accountindex.md | 20 +++---- docs/types/classes/_address_.address.html | 20 +++---- docs/types/classes/_address_.address.md | 18 +++--- .../_attestedcandidate_.attestedcandidate.md | 24 ++++---- .../_attestedcandidate_.availabilityvote.md | 24 ++++---- .../_attestedcandidate_.balanceupload.md | 24 ++++---- .../_attestedcandidate_.candidatereceipt.md | 24 ++++---- .../_attestedcandidate_.candidatesignature.md | 22 ++++---- .../_attestedcandidate_.egressqueueroot.md | 24 ++++---- ...edcandidate_.explicitcandidatesignature.md | 22 ++++---- .../classes/_attestedcandidate_.headdata.md | 20 +++---- ...edcandidate_.implicitcandidatesignature.md | 22 ++++---- ..._attestedcandidate_.validityattestation.md | 32 +++++------ .../_attestedcandidate_.validityvote.md | 24 ++++---- .../classes/_authorityid_.authorityid.html | 26 ++++----- .../classes/_authorityid_.authorityid.md | 24 ++++---- docs/types/classes/_balance_.balance.html | 8 +-- docs/types/classes/_balance_.balance.md | 6 +- docs/types/classes/_balanceof_.balanceof.md | 6 +- .../classes/_bft_.bftauthoritysignature.html | 30 +++++----- .../classes/_bft_.bftauthoritysignature.md | 28 +++++----- .../types/classes/_bft_.bfthashsignature.html | 30 +++++----- docs/types/classes/_bft_.bfthashsignature.md | 28 +++++----- docs/types/classes/_block_.block.html | 34 +++++------ docs/types/classes/_block_.block.md | 32 +++++------ .../classes/_blocknumber_.blocknumber.html | 8 +-- .../classes/_blocknumber_.blocknumber.md | 6 +- docs/types/classes/_bool_.bool.html | 16 +++--- docs/types/classes/_bool_.bool.md | 14 ++--- docs/types/classes/_bytes_.bytes.html | 22 ++++---- docs/types/classes/_bytes_.bytes.md | 20 +++---- .../_chainproperties_.chainproperties.html | 20 +++---- .../_chainproperties_.chainproperties.md | 18 +++--- docs/types/classes/_codec_base_.base.html | 4 +- docs/types/classes/_codec_base_.base.md | 2 +- .../classes/_codec_compact_.compact.html | 36 ++++++------ docs/types/classes/_codec_compact_.compact.md | 34 +++++------ docs/types/classes/_codec_enum_.enum.html | 20 +++---- docs/types/classes/_codec_enum_.enum.md | 18 +++--- .../classes/_codec_enumtype_.enumtype.html | 30 +++++----- .../classes/_codec_enumtype_.enumtype.md | 28 +++++----- docs/types/classes/_codec_int_.int.md | 6 +- docs/types/classes/_codec_option_.option.html | 30 +++++----- docs/types/classes/_codec_option_.option.md | 28 +++++----- docs/types/classes/_codec_set_.set.html | 26 ++++----- docs/types/classes/_codec_set_.set.md | 24 ++++---- docs/types/classes/_codec_struct_.struct.html | 26 ++++----- docs/types/classes/_codec_struct_.struct.md | 24 ++++---- docs/types/classes/_codec_tuple_.tuple.html | 26 ++++----- docs/types/classes/_codec_tuple_.tuple.md | 24 ++++---- .../_codec_typeregistry_.typeregistry.html | 10 ++-- .../_codec_typeregistry_.typeregistry.md | 8 +-- docs/types/classes/_codec_u8a_.u8a.html | 22 ++++---- docs/types/classes/_codec_u8a_.u8a.md | 20 +++---- .../classes/_codec_u8afixed_.u8afixed.html | 24 ++++---- .../classes/_codec_u8afixed_.u8afixed.md | 22 ++++---- docs/types/classes/_codec_uint_.uint.html | 8 +-- docs/types/classes/_codec_uint_.uint.md | 6 +- docs/types/classes/_codec_vector_.vector.html | 30 +++++----- docs/types/classes/_codec_vector_.vector.md | 28 +++++----- docs/types/classes/_codehash_.codehash.md | 22 ++++---- docs/types/classes/_data_.data.html | 22 ++++---- docs/types/classes/_data_.data.md | 20 +++---- .../classes/_digest_.authoritieschange.html | 30 +++++----- .../classes/_digest_.authoritieschange.md | 28 +++++----- .../classes/_digest_.changestrieroot.html | 24 ++++---- .../types/classes/_digest_.changestrieroot.md | 22 ++++---- docs/types/classes/_digest_.digest.html | 28 +++++----- docs/types/classes/_digest_.digest.md | 26 ++++----- docs/types/classes/_digest_.digestitem.html | 38 ++++++------- docs/types/classes/_digest_.digestitem.md | 36 ++++++------ docs/types/classes/_digest_.other.html | 22 ++++---- docs/types/classes/_digest_.other.md | 20 +++---- docs/types/classes/_digest_.seal.html | 30 +++++----- docs/types/classes/_digest_.seal.md | 28 +++++----- docs/types/classes/_event_.event.html | 42 +++++++------- docs/types/classes/_event_.event.md | 40 ++++++------- docs/types/classes/_event_.eventdata.html | 34 +++++------ docs/types/classes/_event_.eventdata.md | 32 +++++------ docs/types/classes/_event_.eventindex.html | 24 ++++---- docs/types/classes/_event_.eventindex.md | 22 ++++---- .../classes/_eventrecord_.applyextrinsic.html | 8 +-- .../classes/_eventrecord_.applyextrinsic.md | 6 +- .../classes/_eventrecord_.eventrecord.html | 30 +++++----- .../classes/_eventrecord_.eventrecord.md | 28 +++++----- .../classes/_eventrecord_.finalization.html | 14 ++--- .../classes/_eventrecord_.finalization.md | 12 ++-- docs/types/classes/_eventrecord_.phase.html | 34 +++++------ docs/types/classes/_eventrecord_.phase.md | 32 +++++------ docs/types/classes/_extrinsic_.extrinsic.html | 50 ++++++++--------- docs/types/classes/_extrinsic_.extrinsic.md | 48 ++++++++-------- .../classes/_extrinsicera_.extrinsicera.html | 24 ++++---- .../classes/_extrinsicera_.extrinsicera.md | 22 ++++---- .../classes/_extrinsics_.extrinsics.html | 30 +++++----- docs/types/classes/_extrinsics_.extrinsics.md | 28 +++++----- ...xtrinsicsignature_.extrinsicsignature.html | 44 +++++++-------- ..._extrinsicsignature_.extrinsicsignature.md | 42 +++++++------- .../classes/_extrinsicstatus_.broadcast.html | 30 +++++----- .../classes/_extrinsicstatus_.broadcast.md | 28 +++++----- .../classes/_extrinsicstatus_.dropped.html | 14 ++--- .../classes/_extrinsicstatus_.dropped.md | 12 ++-- .../_extrinsicstatus_.extrinsicstatus.html | 44 +++++++-------- .../_extrinsicstatus_.extrinsicstatus.md | 42 +++++++------- .../classes/_extrinsicstatus_.finalised.html | 24 ++++---- .../classes/_extrinsicstatus_.finalised.md | 22 ++++---- .../types/classes/_extrinsicstatus_.future.md | 12 ++-- .../classes/_extrinsicstatus_.invalid.md | 12 ++-- docs/types/classes/_extrinsicstatus_.ready.md | 12 ++-- .../classes/_extrinsicstatus_.usurped.html | 24 ++++---- .../classes/_extrinsicstatus_.usurped.md | 22 ++++---- docs/types/classes/_gas_.gas.html | 8 +-- docs/types/classes/_gas_.gas.md | 6 +- docs/types/classes/_h256_.h256.html | 24 ++++---- docs/types/classes/_h256_.h256.md | 22 ++++---- docs/types/classes/_h512_.h512.html | 24 ++++---- docs/types/classes/_h512_.h512.md | 22 ++++---- docs/types/classes/_hash_.hash.html | 24 ++++---- docs/types/classes/_hash_.hash.md | 22 ++++---- docs/types/classes/_header_.header.html | 38 ++++++------- docs/types/classes/_header_.header.md | 36 ++++++------ docs/types/classes/_header_.headerextended.md | 38 ++++++------- docs/types/classes/_health_.health.md | 30 +++++----- docs/types/classes/_i128_.i128.md | 6 +- docs/types/classes/_i16_.i16.md | 6 +- docs/types/classes/_i256_.i256.md | 6 +- docs/types/classes/_i32_.i32.md | 6 +- docs/types/classes/_i64_.i64.md | 6 +- docs/types/classes/_i8_.i8.md | 6 +- ...entofflinereport_.inherentofflinereport.md | 24 ++++---- .../_justification_.justification.html | 22 ++++---- .../classes/_justification_.justification.md | 20 +++---- .../_justification_.rhdjustification.html | 32 +++++------ .../_justification_.rhdjustification.md | 30 +++++----- docs/types/classes/_keyvalue_.keyvalue.html | 30 +++++----- docs/types/classes/_keyvalue_.keyvalue.md | 28 +++++----- .../classes/_keyvalue_.keyvalueoption.html | 30 +++++----- .../classes/_keyvalue_.keyvalueoption.md | 28 +++++----- .../classes/_lockperiods_.lockperiods.md | 6 +- .../classes/_metadata_index_.metadata.md | 34 +++++------ .../_metadata_magicnumber_.magicnumber.md | 6 +- ...ta_metadataversioned_.metadataversioned.md | 34 +++++------ .../_metadata_v0_calls_.outerdispatchcall.md | 30 +++++----- ...etadata_v0_calls_.outerdispatchmetadata.md | 28 +++++----- .../_metadata_v0_events_.eventmetadata.md | 30 +++++----- ..._metadata_v0_events_.outereventmetadata.md | 28 +++++----- ...data_v0_events_.outereventmetadataevent.md | 28 +++++----- .../classes/_metadata_v0_index_.metadatav0.md | 34 +++++------ .../_metadata_v0_modules_.callmetadata.md | 28 +++++----- ...ta_v0_modules_.functionargumentmetadata.md | 28 +++++----- .../_metadata_v0_modules_.functionmetadata.md | 32 +++++------ .../classes/_metadata_v0_modules_.maptype.md | 28 +++++----- .../_metadata_v0_modules_.modulemetadata.md | 28 +++++----- ...adata_v0_modules_.runtimemodulemetadata.md | 30 +++++----- ...ata_v0_modules_.storagefunctionmetadata.md | 34 +++++------ ...ata_v0_modules_.storagefunctionmodifier.md | 18 +++--- ...etadata_v0_modules_.storagefunctiontype.md | 34 +++++------ .../_metadata_v0_modules_.storagemetadata.md | 28 +++++----- .../_metadata_v1_calls_.metadatacall.md | 30 +++++----- .../_metadata_v1_calls_.metadatacallarg.md | 28 +++++----- .../_metadata_v1_events_.metadataevent.md | 30 +++++----- .../_metadata_v1_index_.metadatamodule.md | 34 +++++------ .../classes/_metadata_v1_index_.metadatav1.md | 28 +++++----- .../classes/_metadata_v1_storage_.default.md | 12 ++-- .../classes/_metadata_v1_storage_.maptype.md | 28 +++++----- .../_metadata_v1_storage_.metadatastorage.md | 34 +++++------ ...ata_v1_storage_.metadatastoragemodifier.md | 30 +++++----- ...etadata_v1_storage_.metadatastoragetype.md | 34 +++++------ .../classes/_metadata_v1_storage_.optional.md | 12 ++-- .../_metadata_v1_storage_.plaintype.md | 16 +++--- docs/types/classes/_method_.method.html | 44 +++++++-------- docs/types/classes/_method_.method.md | 42 +++++++------- docs/types/classes/_method_.methodindex.html | 24 ++++---- docs/types/classes/_method_.methodindex.md | 22 ++++---- .../_misbehaviorreport_.bftatreport.html | 32 +++++------ .../_misbehaviorreport_.bftatreport.md | 30 +++++----- .../_misbehaviorreport_.bftdoublecommit.html | 32 +++++------ .../_misbehaviorreport_.bftdoublecommit.md | 30 +++++----- .../_misbehaviorreport_.bftdoubleprepare.html | 32 +++++------ .../_misbehaviorreport_.bftdoubleprepare.md | 30 +++++----- .../_misbehaviorreport_.bftdoublepropose.html | 32 +++++------ .../_misbehaviorreport_.bftdoublepropose.md | 30 +++++----- ...isbehaviorreport_.bftproposeoutofturn.html | 30 +++++----- ..._misbehaviorreport_.bftproposeoutofturn.md | 28 +++++----- .../_misbehaviorreport_.misbehaviorkind.html | 38 ++++++------- .../_misbehaviorreport_.misbehaviorkind.md | 36 ++++++------ ..._misbehaviorreport_.misbehaviorreport.html | 34 +++++------ .../_misbehaviorreport_.misbehaviorreport.md | 32 +++++------ docs/types/classes/_moment_.moment.html | 24 ++++---- docs/types/classes/_moment_.moment.md | 22 ++++---- docs/types/classes/_momentof_.momentof.md | 22 ++++---- ..._newaccountoutcome_.newaccountoutcome.html | 20 +++---- .../_newaccountoutcome_.newaccountoutcome.md | 18 +++--- docs/types/classes/_nonce_.nonce.html | 8 +-- docs/types/classes/_nonce_.nonce.md | 6 +- .../classes/_noncecompact_.noncecompact.md | 34 +++++------ docs/types/classes/_null_.null.html | 14 ++--- docs/types/classes/_null_.null.md | 12 ++-- docs/types/classes/_origin_.origin.html | 16 +++--- docs/types/classes/_origin_.origin.md | 14 ++--- docs/types/classes/_paraid_.paraid.md | 6 +- docs/types/classes/_peerinfo_.peerinfo.md | 36 ++++++------ ..._pendingextrinsics_.pendingextrinsics.html | 30 +++++----- .../_pendingextrinsics_.pendingextrinsics.md | 28 +++++----- docs/types/classes/_perbill_.perbill.html | 8 +-- docs/types/classes/_perbill_.perbill.md | 6 +- docs/types/classes/_permill_.permill.html | 8 +-- docs/types/classes/_permill_.permill.md | 6 +- docs/types/classes/_propindex_.propindex.html | 8 +-- docs/types/classes/_propindex_.propindex.md | 6 +- docs/types/classes/_proposal_.proposal.html | 44 +++++++-------- docs/types/classes/_proposal_.proposal.md | 42 +++++++------- .../_proposalindex_.proposalindex.html | 8 +-- .../classes/_proposalindex_.proposalindex.md | 6 +- .../_referendumindex_.referendumindex.html | 8 +-- .../_referendumindex_.referendumindex.md | 6 +- .../_referenduminfo_.referenduminfo.md | 32 +++++------ .../types/classes/_runtimeversion_.apiid.html | 24 ++++---- docs/types/classes/_runtimeversion_.apiid.md | 22 ++++---- .../_runtimeversion_.runtimeversion.html | 38 ++++++------- .../_runtimeversion_.runtimeversion.md | 36 ++++++------ .../_runtimeversion_.runtimeversionapi.html | 30 +++++----- .../_runtimeversion_.runtimeversionapi.md | 28 +++++----- docs/types/classes/_schedule_.schedule.md | 42 +++++++------- docs/types/classes/_seedof_.seedof.md | 22 ++++---- .../classes/_sessionkey_.sessionkey.html | 26 ++++----- docs/types/classes/_sessionkey_.sessionkey.md | 24 ++++---- docs/types/classes/_signature_.signature.html | 24 ++++---- docs/types/classes/_signature_.signature.md | 22 ++++---- .../_signaturepayload_.signaturepayload.html | 40 ++++++------- .../_signaturepayload_.signaturepayload.md | 38 ++++++------- .../classes/_signedblock_.signedblock.html | 32 +++++------ .../classes/_signedblock_.signedblock.md | 30 +++++----- .../_storagechangeset_.storagechangeset.html | 30 +++++----- .../_storagechangeset_.storagechangeset.md | 28 +++++----- .../classes/_storagedata_.storagedata.html | 22 ++++---- .../classes/_storagedata_.storagedata.md | 20 +++---- .../classes/_storagekey_.storagekey.html | 32 +++++------ docs/types/classes/_storagekey_.storagekey.md | 30 +++++----- .../_storedpendingchange_.nextauthority.html | 30 +++++----- .../_storedpendingchange_.nextauthority.md | 28 +++++----- ...redpendingchange_.storedpendingchange.html | 32 +++++------ ...toredpendingchange_.storedpendingchange.md | 30 +++++----- docs/types/classes/_text_.text.html | 18 +++--- docs/types/classes/_text_.text.md | 16 +++--- docs/types/classes/_type_.type.html | 18 +++--- docs/types/classes/_type_.type.md | 16 +++--- docs/types/classes/_u128_.u128.html | 8 +-- docs/types/classes/_u128_.u128.md | 6 +- docs/types/classes/_u16_.u16.html | 8 +-- docs/types/classes/_u16_.u16.md | 6 +- docs/types/classes/_u256_.u256.html | 8 +-- docs/types/classes/_u256_.u256.md | 6 +- docs/types/classes/_u32_.u32.html | 8 +-- docs/types/classes/_u32_.u32.md | 6 +- docs/types/classes/_u64_.u64.html | 8 +-- docs/types/classes/_u64_.u64.md | 6 +- docs/types/classes/_u8_.u8.html | 8 +-- docs/types/classes/_u8_.u8.md | 6 +- docs/types/classes/_usize_.usize.md | 6 +- .../_validatorprefs_.validatorprefs.html | 30 +++++----- .../_validatorprefs_.validatorprefs.md | 28 +++++----- docs/types/classes/_vote_.vote.md | 10 ++-- docs/types/classes/_voteindex_.voteindex.html | 8 +-- docs/types/classes/_voteindex_.voteindex.md | 6 +- .../_votethreshold_.votethreshold.html | 20 +++---- .../classes/_votethreshold_.votethreshold.md | 18 +++--- .../enums/_codec_createtype_.typedefinfo.md | 14 ++--- docs/types/index.html | 2 +- .../_metadata_types_.metadatainterface.md | 2 +- .../interfaces/_method_.methodfunction.md | 12 ++-- .../_storagekey_.storagefunction.md | 10 ++-- docs/types/interfaces/_types_.codec.md | 14 ++--- docs/types/modules/_accountindex_.md | 2 +- docs/types/modules/_address_.md | 2 +- docs/types/modules/_bft_.md | 4 +- docs/types/modules/_block_.md | 2 +- docs/types/modules/_classes_.md | 2 +- docs/types/modules/_codec_abstractint_.md | 4 +- docs/types/modules/_codec_createtype_.md | 12 ++-- .../modules/_codec_utils_comparearray_.md | 2 +- .../types/modules/_codec_utils_comparemap_.md | 2 +- docs/types/modules/_codec_utils_decodeu8a_.md | 2 +- docs/types/modules/_extrinsicsignature_.md | 4 +- docs/types/modules/_header_.md | 2 +- docs/types/modules/_justification_.md | 2 +- docs/types/modules/_keyvalue_.md | 2 +- docs/types/modules/_metadata_magicnumber_.md | 4 +- .../modules/_metadata_util_flattenuniq_.md | 2 +- .../modules/_metadata_util_validatetypes_.md | 2 +- docs/types/modules/_metadata_v1_tov0_.md | 2 +- docs/types/modules/_storedpendingchange_.md | 4 +- docs/types/modules/_types_.md | 20 +++---- lerna.json | 2 +- package.json | 2 +- packages/api-derive/package.json | 6 +- packages/api/package.json | 14 ++--- packages/rpc-core/package.json | 8 +-- packages/rpc-provider/package.json | 4 +- packages/rpc-rx/package.json | 6 +- packages/type-extrinsics/package.json | 4 +- packages/type-jsonrpc/package.json | 2 +- packages/type-storage/package.json | 4 +- packages/types/package.json | 2 +- 414 files changed, 3655 insertions(+), 3655 deletions(-) diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 70644ab134..eef49d3a15 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -2168,7 +2168,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index 2763aa5c77..0b01cbc321 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -2377,7 +2377,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index cb17c9f346..cc543a18e5 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -2443,7 +2443,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index e7897c10d8..42f3361715 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -2306,7 +2306,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index 18c1e47f94..ddb067df98 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -2670,7 +2670,7 @@ diff --git a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md index 726ef406ff..739608fdcd 100644 --- a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md +++ b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md @@ -29,7 +29,7 @@ *Overrides ReferendumInfo.__constructor* -*Defined in [democracy/referendumInfo.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendumInfo.ts#L19)* +*Defined in [democracy/referendumInfo.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendumInfo.ts#L19)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ getdelay(): `BlockNumber` *Inherited from ReferendumInfo.delay* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L56)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L56)* *__description__*: The delay (in blocks) to wait after a successful referendum before deploying @@ -107,7 +107,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -122,7 +122,7 @@ getend(): `BlockNumber` *Inherited from ReferendumInfo.end* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L35)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L35)* *__description__*: When voting on this referendum will end @@ -135,7 +135,7 @@ ___ getindex(): `ReferendumIndex` -*Defined in [democracy/referendumInfo.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendumInfo.ts#L30)* +*Defined in [democracy/referendumInfo.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendumInfo.ts#L30)* *__description__*: Convenience getter, returns the referendumIndex @@ -150,7 +150,7 @@ getproposal(): `Proposal` *Inherited from ReferendumInfo.proposal* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L42)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L42)* *__description__*: The proposal being voted on @@ -165,7 +165,7 @@ getthreshold(): `VoteThreshold` *Inherited from ReferendumInfo.threshold* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L49)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L49)* *__description__*: The thresholding mechanism to determine whether it passed @@ -245,7 +245,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -288,7 +288,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -309,7 +309,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -384,7 +384,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -399,7 +399,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -414,7 +414,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -429,7 +429,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -444,7 +444,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -480,7 +480,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api-derive/interfaces/_index_.derive.md b/docs/api-derive/interfaces/_index_.derive.md index 2abe7f0655..27bffc7354 100644 --- a/docs/api-derive/interfaces/_index_.derive.md +++ b/docs/api-derive/interfaces/_index_.derive.md @@ -12,7 +12,7 @@ **● accounts**: *`ReturnTypes`<["accounts/index"](../modules/_accounts_index_.md)>* -*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L27)* ___ @@ -21,7 +21,7 @@ ___ **● balances**: *`ReturnTypes`<["balances/index"](../modules/_balances_index_.md)>* -*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L28)* +*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L28)* ___ @@ -30,7 +30,7 @@ ___ **● chain**: *`ReturnTypes`<["chain/index"](../modules/_chain_index_.md)>* -*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L29)* +*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L29)* ___ @@ -39,7 +39,7 @@ ___ **● democracy**: *`ReturnTypes`<["democracy/index"](../modules/_democracy_index_.md)>* -*Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L30)* +*Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L30)* ___ @@ -48,7 +48,7 @@ ___ **● session**: *`ReturnTypes`<["session/index"](../modules/_session_index_.md)>* -*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L31)* ___ @@ -57,7 +57,7 @@ ___ **● staking**: *`ReturnTypes`<["staking/index"](../modules/_staking_index_.md)>* -*Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L32)* ___ diff --git a/docs/api-derive/modules/_accounts_idandindex_.md b/docs/api-derive/modules/_accounts_idandindex_.md index 7f4e193939..8900695969 100644 --- a/docs/api-derive/modules/_accounts_idandindex_.md +++ b/docs/api-derive/modules/_accounts_idandindex_.md @@ -8,7 +8,7 @@ **Ƭ AccountIdAndIndex**: *[`undefined` | `AccountId`, `undefined` | `AccountIndex`]* -*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/idAndIndex.ts#L16)* +*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/idAndIndex.ts#L16)* ___ @@ -20,7 +20,7 @@ ___ ▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/idAndIndex.ts#L18)* +*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/idAndIndex.ts#L18)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_idtoindex_.md b/docs/api-derive/modules/_accounts_idtoindex_.md index 00e7a84de5..85cd227344 100644 --- a/docs/api-derive/modules/_accounts_idtoindex_.md +++ b/docs/api-derive/modules/_accounts_idtoindex_.md @@ -8,7 +8,7 @@ ▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/idToIndex.ts#L13)* +*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/idToIndex.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_indexes_.md b/docs/api-derive/modules/_accounts_indexes_.md index 707df5a8b9..108a3e0d57 100644 --- a/docs/api-derive/modules/_accounts_indexes_.md +++ b/docs/api-derive/modules/_accounts_indexes_.md @@ -8,7 +8,7 @@ **Ƭ AccountIndexes**: *`object`* -*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/indexes.ts#L13)* +*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/indexes.ts#L13)* #### Type declaration @@ -24,7 +24,7 @@ ___ ▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/indexes.ts#L15)* +*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/indexes.ts#L15)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_indextoid_.md b/docs/api-derive/modules/_accounts_indextoid_.md index 8b97365ee3..851da582f0 100644 --- a/docs/api-derive/modules/_accounts_indextoid_.md +++ b/docs/api-derive/modules/_accounts_indextoid_.md @@ -8,7 +8,7 @@ ▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/accounts/indexToId.ts#L14)* +*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/accounts/indexToId.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_fees_.md b/docs/api-derive/modules/_balances_fees_.md index f3014cd5ad..4ca1235d42 100644 --- a/docs/api-derive/modules/_balances_fees_.md +++ b/docs/api-derive/modules/_balances_fees_.md @@ -8,7 +8,7 @@ ▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/fees.ts#L13)* +*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/fees.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_validatingbalance_.md b/docs/api-derive/modules/_balances_validatingbalance_.md index 4895b0c79f..7e642475b1 100644 --- a/docs/api-derive/modules/_balances_validatingbalance_.md +++ b/docs/api-derive/modules/_balances_validatingbalance_.md @@ -8,7 +8,7 @@ ▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/validatingBalance.ts#L16)* +*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/validatingBalance.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_validatingbalances_.md b/docs/api-derive/modules/_balances_validatingbalances_.md index e611cbd6ae..1ccfd96bce 100644 --- a/docs/api-derive/modules/_balances_validatingbalances_.md +++ b/docs/api-derive/modules/_balances_validatingbalances_.md @@ -8,7 +8,7 @@ ▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/validatingBalances.ts#L14)* +*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/validatingBalances.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalance_.md b/docs/api-derive/modules/_balances_votingbalance_.md index 583d5c49ef..e7b88ecbcd 100644 --- a/docs/api-derive/modules/_balances_votingbalance_.md +++ b/docs/api-derive/modules/_balances_votingbalance_.md @@ -8,7 +8,7 @@ ▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/votingBalance.ts#L16)* +*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/votingBalance.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalances_.md b/docs/api-derive/modules/_balances_votingbalances_.md index c7083c1f40..496b912314 100644 --- a/docs/api-derive/modules/_balances_votingbalances_.md +++ b/docs/api-derive/modules/_balances_votingbalances_.md @@ -8,7 +8,7 @@ ▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/votingBalances.ts#L13)* +*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/votingBalances.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md index 91d2113753..9198b48866 100644 --- a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md +++ b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md @@ -8,7 +8,7 @@ ▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)* +*Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_chain_bestnumber_.md b/docs/api-derive/modules/_chain_bestnumber_.md index 10d7ba743f..1eb7d7ac44 100644 --- a/docs/api-derive/modules/_chain_bestnumber_.md +++ b/docs/api-derive/modules/_chain_bestnumber_.md @@ -8,7 +8,7 @@ ▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/bestNumber.ts#L23)* +*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/bestNumber.ts#L23)* *__description__*: Get the latest block number. diff --git a/docs/api-derive/modules/_chain_bestnumberfinalised_.md b/docs/api-derive/modules/_chain_bestnumberfinalised_.md index 8dcc23d575..2be9167954 100644 --- a/docs/api-derive/modules/_chain_bestnumberfinalised_.md +++ b/docs/api-derive/modules/_chain_bestnumberfinalised_.md @@ -8,7 +8,7 @@ ▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* +*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* *__description__*: Get the latest finalised block number. example diff --git a/docs/api-derive/modules/_chain_bestnumberlag_.md b/docs/api-derive/modules/_chain_bestnumberlag_.md index 73da7e20a8..f84a94759e 100644 --- a/docs/api-derive/modules/_chain_bestnumberlag_.md +++ b/docs/api-derive/modules/_chain_bestnumberlag_.md @@ -8,7 +8,7 @@ ▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/bestNumberLag.ts#L25)* +*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/bestNumberLag.ts#L25)* *__description__*: Calculates the lag between finalised head and best head diff --git a/docs/api-derive/modules/_chain_getheader_.md b/docs/api-derive/modules/_chain_getheader_.md index 0dbdcc3a0a..4296a08385 100644 --- a/docs/api-derive/modules/_chain_getheader_.md +++ b/docs/api-derive/modules/_chain_getheader_.md @@ -8,7 +8,7 @@ ▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/getHeader.ts#L25)* +*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/getHeader.ts#L25)* *__description__*: Get the a specific block header and extend it with the author diff --git a/docs/api-derive/modules/_chain_subscribenewhead_.md b/docs/api-derive/modules/_chain_subscribenewhead_.md index 7630a9ac03..9c0c02c89e 100644 --- a/docs/api-derive/modules/_chain_subscribenewhead_.md +++ b/docs/api-derive/modules/_chain_subscribenewhead_.md @@ -8,7 +8,7 @@ **Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]* -*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/subscribeNewHead.ts#L13)* +*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/subscribeNewHead.ts#L13)* ___ @@ -20,7 +20,7 @@ ___ ▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/chain/subscribeNewHead.ts#L26)* +*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/chain/subscribeNewHead.ts#L26)* *__description__*: Subscribe to block headers and extend it with the author diff --git a/docs/api-derive/modules/_democracy_referenduminfo_.md b/docs/api-derive/modules/_democracy_referenduminfo_.md index fd77f9d5cd..451d38cfa5 100644 --- a/docs/api-derive/modules/_democracy_referenduminfo_.md +++ b/docs/api-derive/modules/_democracy_referenduminfo_.md @@ -20,7 +20,7 @@ ▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumInfo.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendumInfo.ts#L35)* +*Defined in [democracy/referendumInfo.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendumInfo.ts#L35)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referenduminfos_.md b/docs/api-derive/modules/_democracy_referenduminfos_.md index 32085f68a7..ef91f09356 100644 --- a/docs/api-derive/modules/_democracy_referenduminfos_.md +++ b/docs/api-derive/modules/_democracy_referenduminfos_.md @@ -8,7 +8,7 @@ ▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumInfos.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendumInfos.ts#L12)* +*Defined in [democracy/referendumInfos.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendumInfos.ts#L12)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referendums_.md b/docs/api-derive/modules/_democracy_referendums_.md index cb02252b6b..726ab7111d 100644 --- a/docs/api-derive/modules/_democracy_referendums_.md +++ b/docs/api-derive/modules/_democracy_referendums_.md @@ -8,7 +8,7 @@ ▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendums.ts#L14)* +*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendums.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referendumvotesfor_.md b/docs/api-derive/modules/_democracy_referendumvotesfor_.md index bafff452d0..b58d04ef1c 100644 --- a/docs/api-derive/modules/_democracy_referendumvotesfor_.md +++ b/docs/api-derive/modules/_democracy_referendumvotesfor_.md @@ -8,7 +8,7 @@ ▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)* +*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_votes_.md b/docs/api-derive/modules/_democracy_votes_.md index b73dd0058d..9d6f4afe02 100644 --- a/docs/api-derive/modules/_democracy_votes_.md +++ b/docs/api-derive/modules/_democracy_votes_.md @@ -8,7 +8,7 @@ ▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/democracy/votes.ts#L12)* +*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/democracy/votes.ts#L12)* **Parameters:** diff --git a/docs/api-derive/modules/_index_.md b/docs/api-derive/modules/_index_.md index 000e753a68..8edf21fccc 100644 --- a/docs/api-derive/modules/_index_.md +++ b/docs/api-derive/modules/_index_.md @@ -20,7 +20,7 @@ ▸ **decorateDerive**(api: *`ApiInterface$Rx`*): [Derive](../interfaces/_index_.derive.md) -*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/index.ts#L35)* +*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/index.ts#L35)* **Parameters:** diff --git a/docs/api-derive/modules/_session_eralength_.md b/docs/api-derive/modules/_session_eralength_.md index bdba02dfe9..fa27e3a8ff 100644 --- a/docs/api-derive/modules/_session_eralength_.md +++ b/docs/api-derive/modules/_session_eralength_.md @@ -8,7 +8,7 @@ ▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/session/eraLength.ts#L13)* +*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/session/eraLength.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_session_eraprogress_.md b/docs/api-derive/modules/_session_eraprogress_.md index d60eb0e719..1060a03c0a 100644 --- a/docs/api-derive/modules/_session_eraprogress_.md +++ b/docs/api-derive/modules/_session_eraprogress_.md @@ -8,7 +8,7 @@ ▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/session/eraProgress.ts#L14)* +*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/session/eraProgress.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_session_sessionprogress_.md b/docs/api-derive/modules/_session_sessionprogress_.md index 34fbafc040..74d3214f1f 100644 --- a/docs/api-derive/modules/_session_sessionprogress_.md +++ b/docs/api-derive/modules/_session_sessionprogress_.md @@ -8,7 +8,7 @@ ▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/session/sessionProgress.ts#L14)* +*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/session/sessionProgress.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_staking_intentionsbalances_.md b/docs/api-derive/modules/_staking_intentionsbalances_.md index e19f0344bc..10b4f5cba7 100644 --- a/docs/api-derive/modules/_staking_intentionsbalances_.md +++ b/docs/api-derive/modules/_staking_intentionsbalances_.md @@ -8,7 +8,7 @@ ▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/staking/intentionsBalances.ts#L18)* +*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/staking/intentionsBalances.ts#L18)* Get the balances for all intentions and their nominators diff --git a/docs/api-derive/modules/_types_.md b/docs/api-derive/modules/_types_.md index fc627f501c..3c5d17fc01 100644 --- a/docs/api-derive/modules/_types_.md +++ b/docs/api-derive/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ DerivedBalances**: *`object`* -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/types.ts#L8)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ DerivedBalancesMap**: *`object`* -*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/types.ts#L26)* #### Type declaration @@ -32,7 +32,7 @@ ___ **Ƭ DerivedFees**: *`object`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/types.ts#L18)* #### Type declaration @@ -43,7 +43,7 @@ ___ **Ƭ DerivedReferendumVote**: *`object`* -*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/types.ts#L30)* #### Type declaration diff --git a/docs/api-derive/modules/_util_cache_.md b/docs/api-derive/modules/_util_cache_.md index 55ac3fd3d4..24fa324a27 100644 --- a/docs/api-derive/modules/_util_cache_.md +++ b/docs/api-derive/modules/_util_cache_.md @@ -8,7 +8,7 @@ ▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)` -*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api-derive/src/util/cache.ts#L23)* +*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/api-derive/src/util/cache.ts#L23)* Create memoization for a 2-currified function. diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md index b1aa896bb9..e5ec2a436b 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -27,7 +27,7 @@ ⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -62,7 +62,7 @@ ___ getderive(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -83,7 +83,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L123)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -96,7 +96,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -109,7 +109,7 @@ ___ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -132,7 +132,7 @@ ___ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -155,7 +155,7 @@ ___ getruntimeMetadata(): `Metadata` -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -168,7 +168,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -181,7 +181,7 @@ ___ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L238)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -204,7 +204,7 @@ ___ gettype(): [ApiType](../modules/_types_.md#apitype) -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -220,7 +220,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -233,7 +233,7 @@ ___ ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -265,7 +265,7 @@ ___ ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -297,7 +297,7 @@ ___ ▸ **registerTypes**(types?: *`RegistryTypes`*): `void` -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -316,7 +316,7 @@ ___ ▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void` -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index 8e05dfe5a7..dc0bb03138 100644 --- a/docs/api/classes/_promise_combinator_.combinator.md +++ b/docs/api/classes/_promise_combinator_.combinator.md @@ -12,7 +12,7 @@ ⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/Combinator.ts#L21)* +*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/Combinator.ts#L21)* **Parameters:** @@ -33,7 +33,7 @@ ___ ▸ **unsubscribe**(): `void` -*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/Combinator.ts#L67)* +*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/Combinator.ts#L67)* **Returns:** `void` diff --git a/docs/api/classes/_promise_index_.apipromise.html b/docs/api/classes/_promise_index_.apipromise.html index 202de32110..721822120d 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -2211,7 +2211,7 @@

constructor

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

Overrides ApiBase.constructor

-

Defined in promise/index.ts:128

+

Defined in promise/index.ts:128

description: Creates an instance of the ApiPromise class

example:

import Api from '@polkadot/api/promise';
@@ -2247,7 +2247,7 @@
 

derive

getderive(): Derive<CodecResult, SubscriptionResult>

Inherited from ApiBase.derive

-

Defined in Base.ts:180

+

Defined in Base.ts:180

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

example:

api.derive.chain.bestNumber((number) => {
@@ -2260,7 +2260,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:123

+

Defined in Base.ts:123

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

Returns: Hash


@@ -2268,14 +2268,14 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:132

+

Defined in Base.ts:132

description: true when subscriptions are supported

Returns: boolean


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:163

+

Defined in promise/index.ts:163

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

Returns: Promise<ApiPromise>


@@ -2283,7 +2283,7 @@

query

getquery(): QueryableStorage<CodecResult, SubscriptionResult>

Inherited from ApiBase.query

-

Defined in Base.ts:200

+

Defined in Base.ts:200

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

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

example:

@@ -2297,7 +2297,7 @@

rpc

getrpc(): DecoratedRpc<CodecResult, SubscriptionResult>

Inherited from ApiBase.rpc

-

Defined in Base.ts:220

+

Defined in Base.ts:220

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

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

example:

@@ -2311,7 +2311,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:139

+

Defined in Base.ts:139

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

Returns: Metadata


@@ -2319,7 +2319,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:148

+

Defined in Base.ts:148

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2327,7 +2327,7 @@

tx

gettx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>

Inherited from ApiBase.tx

-

Defined in Base.ts:238

+

Defined in Base.ts:238

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

example:

api.tx.balances
@@ -2342,7 +2342,7 @@
 

type

gettype(): ApiType

Inherited from ApiBase.type

-

Defined in Base.ts:157

+

Defined in Base.ts:157

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

Returns: ApiType


@@ -2350,14 +2350,14 @@

clone

▸ clone(): ApiPromise

-

Defined in promise/index.ts:170

+

Defined in promise/index.ts:170

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

Returns: ApiPromise


combineLatest

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

-

Defined in promise/index.ts:197

+

Defined in promise/index.ts:197

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

example:

const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
@@ -2401,7 +2401,7 @@
 

▸ disconnect(): void

Implementation of ApiPromiseInterface.disconnect

Inherited from ApiBase.disconnect

-

Defined in Base.ts:247

+

Defined in Base.ts:247

description: Disconnect from the underlying provider, halting all comms

Returns: void


@@ -2409,7 +2409,7 @@

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:270

+

Defined in Base.ts:270

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

example:

api.on('connected', () => {
@@ -2448,7 +2448,7 @@
 

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:295

+

Defined in Base.ts:295

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

example:

api.once('connected', () => {
@@ -2488,7 +2488,7 @@
 

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiPromiseInterface.registerTypes

Inherited from ApiBase.registerTypes

-

Defined in Base.ts:304

+

Defined in Base.ts:304

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

Parameters:

@@ -2512,7 +2512,7 @@

▸ setSigner(signer: Signer): void

Implementation of ApiPromiseInterface.setSigner

Inherited from ApiBase.setSigner

-

Defined in Base.ts:164

+

Defined in Base.ts:164

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

Parameters:

@@ -2534,7 +2534,7 @@

<Static> create

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

-

Defined in promise/index.ts:126

+

Defined in promise/index.ts:126

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

example:

import Api from '@polkadot/api/promise';
@@ -2610,7 +2610,7 @@
     
 
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md index 8ef091ea65..62abde3cd3 100644 --- a/docs/api/classes/_promise_index_.apipromise.md +++ b/docs/api/classes/_promise_index_.apipromise.md @@ -106,7 +106,7 @@ ApiPromise.create().then((api) => { *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/index.ts#L128)* +*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/index.ts#L128)* *__description__*: Creates an instance of the ApiPromise class @@ -142,7 +142,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [Subscri *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -165,7 +165,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L123)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -180,7 +180,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -193,7 +193,7 @@ ___ getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/index.ts#L163)* +*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/index.ts#L163)* *__description__*: Promise that returns the first time we are connected and loaded @@ -208,7 +208,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[Codec *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -233,7 +233,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](), *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -258,7 +258,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -273,7 +273,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -288,7 +288,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L238)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -313,7 +313,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -329,7 +329,7 @@ ___ ▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md) -*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/index.ts#L170)* +*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/index.ts#L170)* *__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection) @@ -342,7 +342,7 @@ ___ ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]() -*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/index.ts#L197)* +*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/index.ts#L197)* *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions @@ -381,7 +381,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -396,7 +396,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -430,7 +430,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -466,7 +466,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -489,7 +489,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -508,7 +508,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/index.ts#L126)* +*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/index.ts#L126)* *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html index e1541afdf7..71d07042cd 100644 --- a/docs/api/classes/_rx_index_.apirx.html +++ b/docs/api/classes/_rx_index_.apirx.html @@ -2225,7 +2225,7 @@

constructor

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

Overrides ApiBase.constructor

-

Defined in rx/index.ts:142

+

Defined in rx/index.ts:142

description: Create an instance of the ApiRx class

example:

import { switchMap } from 'rxjs/operators';
@@ -2263,7 +2263,7 @@
 

derive

getderive(): Derive<RxResult, RxResult>

Inherited from ApiBase.derive

-

Defined in Base.ts:180

+

Defined in Base.ts:180

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

example:

api.derive.chain.bestNumber((number) => {
@@ -2276,7 +2276,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:123

+

Defined in Base.ts:123

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

Returns: Hash


@@ -2284,21 +2284,21 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:132

+

Defined in Base.ts:132

description: true when subscriptions are supported

Returns: boolean


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:182

+

Defined in rx/index.ts:182

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

Returns: Observable<boolean>


isReady

getisReady(): Observable<ApiRx>

-

Defined in rx/index.ts:189

+

Defined in rx/index.ts:189

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

Returns: Observable<ApiRx>


@@ -2306,7 +2306,7 @@

query

getquery(): QueryableStorage<RxResult, RxResult>

Inherited from ApiBase.query

-

Defined in Base.ts:200

+

Defined in Base.ts:200

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

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

example:

@@ -2320,7 +2320,7 @@

rpc

getrpc(): DecoratedRpc<RxResult, RxResult>

Inherited from ApiBase.rpc

-

Defined in Base.ts:220

+

Defined in Base.ts:220

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

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

example:

@@ -2334,7 +2334,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:139

+

Defined in Base.ts:139

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

Returns: Metadata


@@ -2342,7 +2342,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:148

+

Defined in Base.ts:148

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2350,7 +2350,7 @@

tx

gettx(): SubmittableExtrinsics<RxResult, RxResult>

Inherited from ApiBase.tx

-

Defined in Base.ts:238

+

Defined in Base.ts:238

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

example:

api.tx.balances
@@ -2365,7 +2365,7 @@
 

type

gettype(): ApiType

Inherited from ApiBase.type

-

Defined in Base.ts:157

+

Defined in Base.ts:157

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

Returns: ApiType


@@ -2373,7 +2373,7 @@

clone

▸ clone(): ApiRx

-

Defined in rx/index.ts:196

+

Defined in rx/index.ts:196

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

Returns: ApiRx


@@ -2382,7 +2382,7 @@

▸ disconnect(): void

Implementation of ApiRxInterface.disconnect

Inherited from ApiBase.disconnect

-

Defined in Base.ts:247

+

Defined in Base.ts:247

description: Disconnect from the underlying provider, halting all comms

Returns: void


@@ -2390,7 +2390,7 @@

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:270

+

Defined in Base.ts:270

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

example:

api.on('connected', () => {
@@ -2429,7 +2429,7 @@
 

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:295

+

Defined in Base.ts:295

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

example:

api.once('connected', () => {
@@ -2469,7 +2469,7 @@
 

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiRxInterface.registerTypes

Inherited from ApiBase.registerTypes

-

Defined in Base.ts:304

+

Defined in Base.ts:304

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

Parameters:

@@ -2493,7 +2493,7 @@

▸ setSigner(signer: Signer): void

Implementation of ApiRxInterface.setSigner

Inherited from ApiBase.setSigner

-

Defined in Base.ts:164

+

Defined in Base.ts:164

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

Parameters:

@@ -2515,7 +2515,7 @@

<Static> create

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

-

Defined in rx/index.ts:140

+

Defined in rx/index.ts:140

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

example:

import { switchMap } from 'rxjs/operators';
@@ -2593,7 +2593,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index ab2d09b546..322913991e 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -120,7 +120,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/index.ts#L142)* +*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/index.ts#L142)* *__description__*: Create an instance of the ApiRx class @@ -160,7 +160,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -183,7 +183,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L123)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -198,7 +198,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -211,7 +211,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/index.ts#L182)* +*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/index.ts#L182)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -224,7 +224,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/index.ts#L189)* +*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/index.ts#L189)* *__description__*: Observable that returns the first time we are connected and loaded @@ -239,7 +239,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxRes *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -264,7 +264,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../mo *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -289,7 +289,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -304,7 +304,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -319,7 +319,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L238)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -344,7 +344,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -360,7 +360,7 @@ ___ ▸ **clone**(): [ApiRx](_rx_index_.apirx.md) -*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/index.ts#L196)* +*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/index.ts#L196)* *__description__*: Returns a clone of this ApiRx instance (new underlying provider connection) @@ -377,7 +377,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -392,7 +392,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -426,7 +426,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -462,7 +462,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -485,7 +485,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -504,7 +504,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/index.ts#L140)* +*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/index.ts#L140)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md index 414e96a4d7..44f2e2893b 100644 --- a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md @@ -27,7 +27,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [SubmittableExtrinsic.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L71)* +*Defined in [SubmittableExtrinsic.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L71)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ getargs(): `Array`<`Codec`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L76)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L76)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] @@ -107,7 +107,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L83)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L83)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -122,7 +122,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L90)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L90)* *__description__*: The actual data for the Method @@ -139,7 +139,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L97)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -154,7 +154,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L106)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L106)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -169,7 +169,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L115)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L115)* *__description__*: `true` id the extrinsic is signed @@ -184,7 +184,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L122)* *__description__*: The length of the encoded value @@ -199,7 +199,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L129)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L129)* *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic @@ -214,7 +214,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L136)* *__description__*: The \[\[Method\]\] this extrinsic wraps @@ -229,7 +229,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L143)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L143)* *__description__*: The \[\[ExtrinsicSignature\]\] @@ -262,7 +262,7 @@ ___ *Inherited from Extrinsic.addSignature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L150)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L150)* *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) @@ -333,7 +333,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -376,7 +376,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -397,7 +397,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -452,11 +452,11 @@ ___ ▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:144](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L144)* +*Defined in [SubmittableExtrinsic.ts:144](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L144)* **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L145)* +*Defined in [SubmittableExtrinsic.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L145)* **Parameters:** @@ -495,7 +495,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [SubmittableExtrinsic.ts:162](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L162)* +*Defined in [SubmittableExtrinsic.ts:162](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L162)* **Parameters:** @@ -515,7 +515,7 @@ ___ ▸ **signAndSend**(account: *`KeyringPair` | `string` | `AccountId` | `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:174](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L174)* +*Defined in [SubmittableExtrinsic.ts:174](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L174)* **Parameters:** @@ -526,7 +526,7 @@ ___ **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:175](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L175)* +*Defined in [SubmittableExtrinsic.ts:175](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L175)* **Parameters:** @@ -546,7 +546,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -563,7 +563,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L168)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L168)* *__description__*: Returns a hex string representation of the value @@ -580,7 +580,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L175)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L175)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -595,7 +595,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -612,7 +612,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L183)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L183)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -648,7 +648,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -667,7 +667,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api/classes/_submittableextrinsic_.submittableresult.md b/docs/api/classes/_submittableextrinsic_.submittableresult.md index 1a83345c05..e59ab925bc 100644 --- a/docs/api/classes/_submittableextrinsic_.submittableresult.md +++ b/docs/api/classes/_submittableextrinsic_.submittableresult.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [SubmittableExtrinsic.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L37)* +*Defined in [SubmittableExtrinsic.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L37)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getevents(): `Array`<`EventRecord`> -*Defined in [SubmittableExtrinsic.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L49)* +*Defined in [SubmittableExtrinsic.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L49)* *__description__*: the contained events @@ -113,7 +113,7 @@ ___ getstatus(): `ExtrinsicStatus` -*Defined in [SubmittableExtrinsic.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L56)* +*Defined in [SubmittableExtrinsic.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L56)* *__description__*: the status @@ -126,7 +126,7 @@ ___ gettype(): `string` -*Defined in [SubmittableExtrinsic.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/SubmittableExtrinsic.ts#L63)* +*Defined in [SubmittableExtrinsic.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/SubmittableExtrinsic.ts#L63)* *__description__*: the type @@ -206,7 +206,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -249,7 +249,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -270,7 +270,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -345,7 +345,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -360,7 +360,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -375,7 +375,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -390,7 +390,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -405,7 +405,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -441,7 +441,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index aae16c8114..89c459b660 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2237,7 +2237,7 @@
diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md index 46c90b1395..4461b6008d 100644 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md +++ b/docs/api/interfaces/_promise_types_.apipromiseinterface.md @@ -24,7 +24,7 @@ *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -59,7 +59,7 @@ ___ **● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* -*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L16)* +*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L16)* ___ @@ -73,7 +73,7 @@ getderive(): [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -96,7 +96,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L123)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -111,7 +111,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -126,7 +126,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../mod *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -151,7 +151,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_prom *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -176,7 +176,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -191,7 +191,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -206,7 +206,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult] *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L238)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -231,7 +231,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -249,7 +249,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -264,7 +264,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -298,7 +298,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -332,7 +332,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -353,7 +353,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md index 3daacdd4c6..42dac97a1d 100644 --- a/docs/api/interfaces/_rx_types_.apirxinterface.md +++ b/docs/api/interfaces/_rx_types_.apirxinterface.md @@ -24,7 +24,7 @@ *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -59,7 +59,7 @@ ___ **● isConnected**: *`Observable`<`boolean`>* -*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/types.ts#L13)* +*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/types.ts#L13)* ___ @@ -68,7 +68,7 @@ ___ **● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* -*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/types.ts#L14)* +*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/types.ts#L14)* ___ @@ -82,7 +82,7 @@ getderive(): [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxr *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -105,7 +105,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L123)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -120,7 +120,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -135,7 +135,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../module *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -160,7 +160,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_type *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -185,7 +185,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -200,7 +200,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -215,7 +215,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](.. *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L238)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -240,7 +240,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -258,7 +258,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -273,7 +273,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -307,7 +307,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -341,7 +341,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -362,7 +362,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md index 1bf22bed72..439b1fb8b6 100644 --- a/docs/api/interfaces/_types_.apibaseinterface.md +++ b/docs/api/interfaces/_types_.apibaseinterface.md @@ -25,7 +25,7 @@ **● on**: *`function`* -*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L140)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -46,7 +46,7 @@ ___ **● once**: *`function`* -*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L141)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -67,7 +67,7 @@ ___ **● type**: *[ApiType](../modules/_types_.md#apitype)* -*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L138)* +*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L138)* ___ diff --git a/docs/api/interfaces/_types_.apiinterface_decorated.md b/docs/api/interfaces/_types_.apiinterface_decorated.md index 14b3760d10..ae8369f736 100644 --- a/docs/api/interfaces/_types_.apiinterface_decorated.md +++ b/docs/api/interfaces/_types_.apiinterface_decorated.md @@ -15,7 +15,7 @@ **● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:124](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L124)* ___ @@ -24,7 +24,7 @@ ___ **● genesisHash**: *`Hash`* -*Defined in [types.ts:120](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L120)* ___ @@ -33,7 +33,7 @@ ___ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L121)* ___ @@ -42,7 +42,7 @@ ___ **● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L125)* ___ @@ -51,7 +51,7 @@ ___ **● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:126](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L126)* +*Defined in [types.ts:126](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L126)* ___ @@ -60,7 +60,7 @@ ___ **● runtimeMetadata**: *`Metadata`* -*Defined in [types.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L122)* +*Defined in [types.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L122)* ___ @@ -69,7 +69,7 @@ ___ **● runtimeVersion**: *`RuntimeVersion`* -*Defined in [types.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L123)* +*Defined in [types.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L123)* ___ @@ -78,7 +78,7 @@ ___ **● signer**: *[Signer](_types_.signer.md)* -*Defined in [types.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L128)* +*Defined in [types.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L128)* ___ @@ -87,7 +87,7 @@ ___ **● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:127](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L127)* +*Defined in [types.ts:127](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L127)* ___ diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md index 9185b5ccd9..275eb7ef6c 100644 --- a/docs/api/interfaces/_types_.apioptions.md +++ b/docs/api/interfaces/_types_.apioptions.md @@ -12,7 +12,7 @@ **● provider**: *`ProviderInterface`* -*Defined in [types.ts:103](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L103)* +*Defined in [types.ts:103](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L103)* *__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944` @@ -23,7 +23,7 @@ ___ **● signer**: *[Signer](_types_.signer.md)* -*Defined in [types.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L107)* *__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -34,7 +34,7 @@ ___ **● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>* -*Defined in [types.ts:111](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L111)* +*Defined in [types.ts:111](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L111)* *__description__*: The source object to use for runtime information (only used when cloning) @@ -45,7 +45,7 @@ ___ **● types**: *`RegistryTypes`* -*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L116)* *__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime. diff --git a/docs/api/interfaces/_types_.decoratedrpc.md b/docs/api/interfaces/_types_.decoratedrpc.md index bef40d38eb..e45c6796c6 100644 --- a/docs/api/interfaces/_types_.decoratedrpc.md +++ b/docs/api/interfaces/_types_.decoratedrpc.md @@ -15,7 +15,7 @@ **● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L34)* ___ @@ -24,7 +24,7 @@ ___ **● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L35)* ___ @@ -33,7 +33,7 @@ ___ **● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L36)* ___ @@ -42,7 +42,7 @@ ___ **● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L37)* ___ diff --git a/docs/api/interfaces/_types_.decoratedrpc_method.md b/docs/api/interfaces/_types_.decoratedrpc_method.md index 77c0d783df..19395f3c2b 100644 --- a/docs/api/interfaces/_types_.decoratedrpc_method.md +++ b/docs/api/interfaces/_types_.decoratedrpc_method.md @@ -14,7 +14,7 @@ ▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult` -*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L23)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** `SubscriptionResult` -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L24)* **Parameters:** @@ -35,7 +35,7 @@ **Returns:** `SubscriptionResult` -*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L25)* **Parameters:** diff --git a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md index b043ec1a69..978d5cb02f 100644 --- a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md +++ b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md @@ -14,7 +14,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L50)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** `CodecResult` -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -42,7 +42,7 @@ **● at**: *`function`* -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L52)* #### Type declaration ▸(hash: *`Hash` | `Uint8Array` | `string`*, arg?: *`CodecArg`*): `CodecResult` @@ -63,7 +63,7 @@ ___ **● hash**: *`function`* -*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L53)* #### Type declaration ▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`> @@ -83,7 +83,7 @@ ___ **● key**: *`function`* -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L54)* #### Type declaration ▸(arg?: *`CodecArg`*): `string` @@ -105,7 +105,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L14)* ___ @@ -116,7 +116,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L15)* ___ @@ -127,7 +127,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L16)* ___ @@ -136,7 +136,7 @@ ___ **● size**: *`function`* -*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L55)* #### Type declaration ▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`> @@ -158,7 +158,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_types_.signer.md b/docs/api/interfaces/_types_.signer.md index 1cfc57c15b..b9e05f2524 100644 --- a/docs/api/interfaces/_types_.signer.md +++ b/docs/api/interfaces/_types_.signer.md @@ -12,7 +12,7 @@ **● update**: *`undefined` | `function`* -*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L153)* *__description__*: Receives an update for the extrinsic signed by a `signer.sign` @@ -26,7 +26,7 @@ ___ ▸ **sign**(extrinsic: *`Extrinsic`*, address: *`string`*, options: *`SignatureOptions`*): `Promise`<`number`> -*Defined in [types.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L148)* +*Defined in [types.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L148)* *__description__*: Signs an extrinsic, returning an id (>0) that can be used to retrieve updates diff --git a/docs/api/interfaces/_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_types_.submittableextrinsicfunction.md index 0ed6e31fce..6bf4ac799a 100644 --- a/docs/api/interfaces/_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_types_.submittableextrinsicfunction.md @@ -14,7 +14,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L76)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L28)* **Parameters:** @@ -44,7 +44,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L30)* ___ @@ -55,7 +55,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L31)* ___ @@ -66,7 +66,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L32)* ___ @@ -77,7 +77,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L33)* ___ @@ -88,7 +88,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index a8eab8eee1..ff438b5c58 100644 --- a/docs/api/modules/_promise_combinator_.md +++ b/docs/api/modules/_promise_combinator_.md @@ -21,7 +21,7 @@ **Ƭ CombinatorCallback**: *`function`* -*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/Combinator.ts#L9)* +*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/Combinator.ts#L9)* #### Type declaration ▸(value: *`Array`<`any`>*): `any` @@ -41,7 +41,7 @@ ___ **Ƭ CombinatorFunction**: *`function`* -*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/Combinator.ts#L10)* +*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/Combinator.ts#L10)* #### Type declaration ▸(cb: *`function`*): [SubscriptionResult]() diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md index 5db94b9c50..cf375bb107 100644 --- a/docs/api/modules/_promise_types_.md +++ b/docs/api/modules/_promise_types_.md @@ -24,7 +24,7 @@ **Ƭ CodecResult**: *`Promise`<`Codec`>* -*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L13)* +*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L13)* ___ @@ -33,7 +33,7 @@ ___ **Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L19)* +*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L19)* ___ @@ -42,7 +42,7 @@ ___ **Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L20)* +*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L20)* ___ @@ -51,7 +51,7 @@ ___ **Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L21)* +*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L21)* ___ @@ -60,7 +60,7 @@ ___ **Ƭ SubscriptionResult**: *`Promise`<`function`>* -*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/promise/types.ts#L11)* +*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/promise/types.ts#L11)* ___ diff --git a/docs/api/modules/_rx_types_.md b/docs/api/modules/_rx_types_.md index 898ba099a8..40373c6c5a 100644 --- a/docs/api/modules/_rx_types_.md +++ b/docs/api/modules/_rx_types_.md @@ -20,7 +20,7 @@ **Ƭ RxResult**: *`Observable`<`Codec`>* -*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/rx/types.ts#L10)* +*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/rx/types.ts#L10)* ___ diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md index 1d3f2c8fa4..29654b7411 100644 --- a/docs/api/modules/_types_.md +++ b/docs/api/modules/_types_.md @@ -42,7 +42,7 @@ **Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` | "ready"* -*Defined in [types.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L133)* +*Defined in [types.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L133)* ___ @@ -51,7 +51,7 @@ ___ **Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>* -*Defined in [types.ts:131](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L131)* +*Defined in [types.ts:131](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L131)* ___ @@ -60,7 +60,7 @@ ___ **Ƭ ApiType**: *"promise" | "rxjs"* -*Defined in [types.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L135)* +*Defined in [types.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L135)* ___ @@ -69,7 +69,7 @@ ___ **Ƭ DeriveMethod**: *`function`* -*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L88)* +*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L88)* #### Type declaration ▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult` @@ -89,7 +89,7 @@ ___ **Ƭ HashResult**: *`HashResult<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L40)* ___ @@ -98,7 +98,7 @@ ___ **Ƭ OnCallDefinition**: *`function`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L18)* #### Type declaration ▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` | `false` | `true`*): `CodecResult` | `SubscriptionResult` @@ -121,7 +121,7 @@ ___ **Ƭ OnCallFunction**: *`function`* -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L20)* #### Type declaration ▸(...params: *`Array`<`CodecArg`>*): `CodecResult` | `SubscriptionResult` @@ -141,7 +141,7 @@ ___ **Ƭ QueryableStorageFunction**: *`QueryableStorageFunction<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L63)* ___ @@ -150,7 +150,7 @@ ___ **Ƭ U64Result**: *`U64Result<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/types.ts#L45)* ___ diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md index 7ee3ccf680..5161c572cc 100644 --- a/docs/api/modules/_util_filterevents_.md +++ b/docs/api/modules/_util_filterevents_.md @@ -8,7 +8,7 @@ ▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> | `undefined` -*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/api/src/util/filterEvents.ts#L9)* +*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/api/src/util/filterEvents.ts#L9)* **Parameters:** diff --git a/docs/examples/promise/01_simple_connect/index.html b/docs/examples/promise/01_simple_connect/index.html index 6968136d2e..35ff78ef5d 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -2203,7 +2203,7 @@ diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index b89ae0785b..530a68a5ae 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -2201,7 +2201,7 @@ diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html index c98ec6e62e..5c76c8f765 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -2213,7 +2213,7 @@ diff --git a/docs/examples/promise/04_unsubscribe/index.html b/docs/examples/promise/04_unsubscribe/index.html index 3db71a667e..3c80c5d54b 100644 --- a/docs/examples/promise/04_unsubscribe/index.html +++ b/docs/examples/promise/04_unsubscribe/index.html @@ -2204,7 +2204,7 @@ diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index 5538cfe13a..900bbfe7f8 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -2218,7 +2218,7 @@ diff --git a/docs/examples/promise/06_make_transfer/index.html b/docs/examples/promise/06_make_transfer/index.html index a880c55fa0..31e0e78c27 100644 --- a/docs/examples/promise/06_make_transfer/index.html +++ b/docs/examples/promise/06_make_transfer/index.html @@ -2216,7 +2216,7 @@ diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html index 4b663e5adc..f32a60cadb 100644 --- a/docs/examples/promise/08_system_events/index.html +++ b/docs/examples/promise/08_system_events/index.html @@ -2214,7 +2214,7 @@ diff --git a/docs/examples/promise/09_transfer_events/index.html b/docs/examples/promise/09_transfer_events/index.html index 8cfdce4e17..c488617ec4 100644 --- a/docs/examples/promise/09_transfer_events/index.html +++ b/docs/examples/promise/09_transfer_events/index.html @@ -2235,7 +2235,7 @@ diff --git a/docs/examples/promise/10_upgrade_chain/index.html b/docs/examples/promise/10_upgrade_chain/index.html index fbccce57f2..c472315ead 100644 --- a/docs/examples/promise/10_upgrade_chain/index.html +++ b/docs/examples/promise/10_upgrade_chain/index.html @@ -2237,7 +2237,7 @@ diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index b166ffffb0..cdd2a52af5 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -2193,7 +2193,7 @@ diff --git a/docs/examples/rx/01_simple_connect/index.html b/docs/examples/rx/01_simple_connect/index.html index 703c374a0c..78888f64a6 100644 --- a/docs/examples/rx/01_simple_connect/index.html +++ b/docs/examples/rx/01_simple_connect/index.html @@ -2207,7 +2207,7 @@ diff --git a/docs/examples/rx/02_listen_to_blocks/index.html b/docs/examples/rx/02_listen_to_blocks/index.html index 958837b9d5..9a58675b95 100644 --- a/docs/examples/rx/02_listen_to_blocks/index.html +++ b/docs/examples/rx/02_listen_to_blocks/index.html @@ -2202,7 +2202,7 @@ diff --git a/docs/examples/rx/03_listen_to_balance_change/index.html b/docs/examples/rx/03_listen_to_balance_change/index.html index 68a9c00af7..4eb717b08f 100644 --- a/docs/examples/rx/03_listen_to_balance_change/index.html +++ b/docs/examples/rx/03_listen_to_balance_change/index.html @@ -2219,7 +2219,7 @@ diff --git a/docs/examples/rx/04_unsubscribe/index.html b/docs/examples/rx/04_unsubscribe/index.html index e88650b9ec..dc292ab5df 100644 --- a/docs/examples/rx/04_unsubscribe/index.html +++ b/docs/examples/rx/04_unsubscribe/index.html @@ -2207,7 +2207,7 @@ diff --git a/docs/examples/rx/05_read_storage/index.html b/docs/examples/rx/05_read_storage/index.html index 3d109d8979..c9bdb0547e 100644 --- a/docs/examples/rx/05_read_storage/index.html +++ b/docs/examples/rx/05_read_storage/index.html @@ -2232,7 +2232,7 @@ diff --git a/docs/examples/rx/06_make_transfer/index.html b/docs/examples/rx/06_make_transfer/index.html index cdf611119e..bcb9b22eed 100644 --- a/docs/examples/rx/06_make_transfer/index.html +++ b/docs/examples/rx/06_make_transfer/index.html @@ -2216,7 +2216,7 @@ diff --git a/docs/examples/rx/08_system_events/index.html b/docs/examples/rx/08_system_events/index.html index b0e5621522..fd1f8f995a 100644 --- a/docs/examples/rx/08_system_events/index.html +++ b/docs/examples/rx/08_system_events/index.html @@ -2218,7 +2218,7 @@ diff --git a/docs/examples/rx/09_transfer_events/index.html b/docs/examples/rx/09_transfer_events/index.html index d6e47980db..15ba38490a 100644 --- a/docs/examples/rx/09_transfer_events/index.html +++ b/docs/examples/rx/09_transfer_events/index.html @@ -2235,7 +2235,7 @@ diff --git a/docs/examples/rx/10_upgrade_chain/index.html b/docs/examples/rx/10_upgrade_chain/index.html index 733d599cde..10b00172d1 100644 --- a/docs/examples/rx/10_upgrade_chain/index.html +++ b/docs/examples/rx/10_upgrade_chain/index.html @@ -2240,7 +2240,7 @@ diff --git a/docs/examples/rx/index.html b/docs/examples/rx/index.html index 9d7835d749..c8fc97585e 100644 --- a/docs/examples/rx/index.html +++ b/docs/examples/rx/index.html @@ -2193,7 +2193,7 @@ diff --git a/docs/index.html b/docs/index.html index ff1452895a..f6d4b34885 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2186,7 +2186,7 @@ diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index bdd5a44463..f40298184b 100644 --- a/docs/rpc-core/classes/_index_.rpc.md +++ b/docs/rpc-core/classes/_index_.rpc.md @@ -38,7 +38,7 @@ const api = new Api(provider); ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L46)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L42)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L43)* ___ @@ -82,7 +82,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L44)* ___ @@ -93,7 +93,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L45)* ___ @@ -104,7 +104,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)* -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L46)* ___ @@ -116,7 +116,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [index.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L90)* +*Defined in [index.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L90)* *__description__*: Manually disconnect from the attached provider @@ -129,7 +129,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/index.ts#L79)* +*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/index.ts#L79)* *__name__*: signature diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md index 420771e69e..e3f4eaa2ac 100644 --- a/docs/rpc-core/interfaces/_types_.rpcinterface.md +++ b/docs/rpc-core/interfaces/_types_.rpcinterface.md @@ -16,7 +16,7 @@ **● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L17)* ___ @@ -25,7 +25,7 @@ ___ **● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L18)* ___ @@ -34,7 +34,7 @@ ___ **● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L19)* ___ @@ -43,7 +43,7 @@ ___ **● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L20)* ___ diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md index 7d7dd05a26..dbd79cb9b6 100644 --- a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md +++ b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L5)* **Parameters:** @@ -25,7 +25,7 @@ **● subscription**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L8)* ___ @@ -34,7 +34,7 @@ ___ **● unsubscribe**: *`function`* -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L9)* #### Type declaration ▸(id: *`number`*): `Promise`<`any`> diff --git a/docs/rpc-core/modules/_types_.md b/docs/rpc-core/modules/_types_.md index e50019e078..4d92c87007 100644 --- a/docs/rpc-core/modules/_types_.md +++ b/docs/rpc-core/modules/_types_.md @@ -21,7 +21,7 @@ **Ƭ RpcInterface$Section**: *`object`* -*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-core/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-core/src/types.ts#L12)* #### Type declaration diff --git a/docs/rpc-provider/classes/_coder_index_.rpccoder.md b/docs/rpc-provider/classes/_coder_index_.rpccoder.md index 190f2879a1..011361ff07 100644 --- a/docs/rpc-provider/classes/_coder_index_.rpccoder.md +++ b/docs/rpc-provider/classes/_coder_index_.rpccoder.md @@ -12,7 +12,7 @@ ▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any` -*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/coder/index.ts#L12)* **Parameters:** @@ -29,7 +29,7 @@ ___ ▸ **encodeJson**(method: *`string`*, params: *`any` | `Array`<`any`>*): `string` -*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/coder/index.ts#L33)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **encodeObject**(method: *`string`*, params: *`any` | `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest) -*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/coder/index.ts#L39)* **Parameters:** @@ -65,7 +65,7 @@ ___ ▸ **getId**(): `number` -*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/coder/index.ts#L48)* **Returns:** `number` diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.html b/docs/rpc-provider/classes/_http_index_.httpprovider.html index 7d6c3acecf..85f990da93 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -2156,7 +2156,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

@@ -2182,7 +2182,7 @@

hasSubscriptions

gethasSubscriptions(): boolean

-

Defined in http/index.ts:55

+

Defined in http/index.ts:55

summary: true when this provider supports subscriptions

Returns: boolean


@@ -2191,7 +2191,7 @@

clone

▸ clone(): HttpProvider

Implementation of ProviderInterface.clone

-

Defined in http/index.ts:62

+

Defined in http/index.ts:62

description: Returns a clone of the object

Returns: HttpProvider


@@ -2199,7 +2199,7 @@

disconnect

▸ disconnect(): void

Implementation of ProviderInterface.disconnect

-

Defined in http/index.ts:69

+

Defined in http/index.ts:69

description: Manually disconnect from the connection

Returns: void


@@ -2207,7 +2207,7 @@

isConnected

▸ isConnected(): boolean

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:77

+

Defined in http/index.ts:77

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -2216,7 +2216,7 @@ true if connected

on

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

Implementation of ProviderInterface.on

-

Defined in http/index.ts:85

+

Defined in http/index.ts:85

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

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

Parameters:

@@ -2244,7 +2244,7 @@ true if connected

send

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

Implementation of ProviderInterface.send

-

Defined in http/index.ts:92

+

Defined in http/index.ts:92

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

Parameters:

@@ -2271,7 +2271,7 @@ true if connected

subscribe

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

Implementation of ProviderInterface.subscribe

-

Defined in http/index.ts:114

+

Defined in http/index.ts:114

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

Parameters:

@@ -2306,7 +2306,7 @@ true if connected

unsubscribe

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

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:123

+

Defined in http/index.ts:123

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

Parameters:

@@ -2376,7 +2376,7 @@ true if connected

diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md index d4f496b5db..eafd5fdb06 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -54,7 +54,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L55)* +*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L55)* *__summary__*: `true` when this provider supports subscriptions @@ -72,7 +72,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* -*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L62)* +*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L62)* *__description__*: Returns a clone of the object @@ -87,7 +87,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* -*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L69)* +*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L69)* *__description__*: Manually disconnect from the connection @@ -102,7 +102,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L77)* +*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L77)* *__summary__*: Whether the node is connected or not. @@ -118,7 +118,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L85)* +*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L85)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -142,7 +142,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L92)* +*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L92)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -164,7 +164,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)* -*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L114)* +*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L114)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -188,7 +188,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/index.ts#L123)* +*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/index.ts#L123)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md index 61d5409159..6a9cebe82b 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -19,7 +19,7 @@ A mock provider mainly used for testing. ⊕ **new Mock**(): [Mock](_mock_index_.mock.md) -*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L68)* +*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L68)* **Returns:** [Mock](_mock_index_.mock.md) @@ -33,7 +33,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L43)* +*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L43)* ___ @@ -49,7 +49,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L57)* +*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L57)* ___ @@ -61,7 +61,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L74)* **Returns:** `boolean` @@ -77,7 +77,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L78)* **Returns:** [Mock](_mock_index_.mock.md) @@ -90,7 +90,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* -*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L82)* +*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L82)* **Returns:** `void` @@ -103,7 +103,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L86)* +*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L86)* **Returns:** `boolean` @@ -116,7 +116,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L90)* +*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L90)* **Parameters:** @@ -136,7 +136,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L94)* +*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L94)* **Parameters:** @@ -154,7 +154,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L102)* +*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L102)* **Parameters:** @@ -175,7 +175,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/index.ts#L122)* +*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/index.ts#L122)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 72e1572cba..93f7408723 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -2156,7 +2156,7 @@

constructor

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

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

@@ -2188,7 +2188,7 @@

hasSubscriptions

gethasSubscriptions(): boolean

-

Defined in ws/index.ts:101

+

Defined in ws/index.ts:101

summary: true when this provider supports subscriptions

Returns: boolean


@@ -2196,14 +2196,14 @@

clone

▸ clone(): WsProvider

-

Defined in ws/index.ts:108

+

Defined in ws/index.ts:108

description: Returns a clone of the object

Returns: WsProvider


connect

▸ connect(): void

-

Defined in ws/index.ts:117

+

Defined in ws/index.ts:117

summary: Manually connect

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

Returns: void

@@ -2211,14 +2211,14 @@

disconnect

▸ disconnect(): void

-

Defined in ws/index.ts:133

+

Defined in ws/index.ts:133

description: Manually disconnect from the connection, clearing autoconnect logic

Returns: void


isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:150

+

Defined in ws/index.ts:150

summary: Whether the node is connected or not.

Returns: boolean true if connected

@@ -2226,7 +2226,7 @@ true if connected

on

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

-

Defined in ws/index.ts:159

+

Defined in ws/index.ts:159

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

Parameters:

@@ -2255,7 +2255,7 @@ true if connected

send

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

-

Defined in ws/index.ts:169

+

Defined in ws/index.ts:169

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

Parameters:

@@ -2289,7 +2289,7 @@ true if connected

subscribe

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

-

Defined in ws/index.ts:223

+

Defined in ws/index.ts:223

name: subscribe

summary: Allows subscribing to a specific event.

example:

@@ -2340,7 +2340,7 @@ 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:232

+

Defined in ws/index.ts:232

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -2410,7 +2410,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]] diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.md b/docs/rpc-provider/classes/_ws_index_.wsprovider.md index 1290e73098..a61db4d345 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -55,7 +55,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L101)* +*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L101)* *__summary__*: `true` when this provider supports subscriptions @@ -71,7 +71,7 @@ ___ ▸ **clone**(): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L108)* +*Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L108)* *__description__*: Returns a clone of the object @@ -84,7 +84,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L117)* +*Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L117)* *__summary__*: Manually connect @@ -99,7 +99,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L133)* +*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L133)* *__description__*: Manually disconnect from the connection, clearing autoconnect logic @@ -112,7 +112,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L150)* +*Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L150)* *__summary__*: Whether the node is connected or not. @@ -126,7 +126,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L159)* +*Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L159)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -146,7 +146,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L169)* +*Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L169)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -167,7 +167,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L223)* +*Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L223)* *__name__*: subscribe @@ -205,7 +205,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/ws/index.ts#L232)* +*Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/ws/index.ts#L232)* *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html index 608de8dedf..2abe6513f2 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -2204,7 +2204,7 @@ diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.md b/docs/rpc-provider/interfaces/_types_.providerinterface.md index 49631cc7e8..649fd442ef 100644 --- a/docs/rpc-provider/interfaces/_types_.providerinterface.md +++ b/docs/rpc-provider/interfaces/_types_.providerinterface.md @@ -17,7 +17,7 @@ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L45)* ___ @@ -29,7 +29,7 @@ ___ ▸ **clone**(): [ProviderInterface](_types_.providerinterface.md) -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L46)* **Returns:** [ProviderInterface](_types_.providerinterface.md) @@ -40,7 +40,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L47)* **Returns:** `void` @@ -51,7 +51,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L48)* **Returns:** `boolean` @@ -62,7 +62,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L49)* **Parameters:** @@ -80,7 +80,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L50)* **Parameters:** @@ -98,7 +98,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L51)* **Parameters:** @@ -118,7 +118,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L52)* **Parameters:** diff --git a/docs/rpc-provider/modules/_http_types_.md b/docs/rpc-provider/modules/_http_types_.md index cbe0446771..9d4d391d23 100644 --- a/docs/rpc-provider/modules/_http_types_.md +++ b/docs/rpc-provider/modules/_http_types_.md @@ -8,7 +8,7 @@ **Ƭ HttpState**: *`object`* -*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/http/types.ts#L9)* +*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/http/types.ts#L9)* #### Type declaration diff --git a/docs/rpc-provider/modules/_mock_types_.md b/docs/rpc-provider/modules/_mock_types_.md index 21526f6f17..1f427041dc 100644 --- a/docs/rpc-provider/modules/_mock_types_.md +++ b/docs/rpc-provider/modules/_mock_types_.md @@ -8,7 +8,7 @@ **Ƭ MockState$Db**: *`object`* -*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/types.ts#L16)* +*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/types.ts#L16)* #### Type declaration @@ -21,7 +21,7 @@ ___ **Ƭ MockState$Requests**: *`object`* -*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/types.ts#L20)* +*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/types.ts#L20)* #### Type declaration @@ -45,7 +45,7 @@ ___ **Ƭ MockState$Subscription$Callback**: *`function`* -*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/types.ts#L5)* +*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/types.ts#L5)* #### Type declaration ▸(error: *`Error` | `null`*, value: *`any`*): `void` @@ -66,7 +66,7 @@ ___ **Ƭ MockState$Subscriptions**: *`object`* -*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/mock/types.ts#L7)* +*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/mock/types.ts#L7)* #### Type declaration diff --git a/docs/rpc-provider/modules/_types_.md b/docs/rpc-provider/modules/_types_.md index 696a62a2dd..654f79bc87 100644 --- a/docs/rpc-provider/modules/_types_.md +++ b/docs/rpc-provider/modules/_types_.md @@ -27,7 +27,7 @@ **Ƭ JsonRpcObject**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L5)* #### Type declaration @@ -38,7 +38,7 @@ ___ **Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L10)* ___ @@ -47,7 +47,7 @@ ___ **Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)* -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L36)* ___ @@ -56,7 +56,7 @@ ___ **Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L34)* ___ @@ -65,7 +65,7 @@ ___ **Ƭ JsonRpcResponseBase$Error**: *`object`* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L15)* #### Type declaration @@ -76,7 +76,7 @@ ___ **Ƭ ProviderInterface$Callback**: *`function`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L38)* #### Type declaration ▸(result: *`any`*): `void` @@ -96,7 +96,7 @@ ___ **Ƭ ProviderInterface$EmitCb**: *`function`* -*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L42)* #### Type declaration ▸(value?: *`any`*): `any` @@ -116,7 +116,7 @@ ___ **Ƭ ProviderInterface$Emitted**: *"connected" | "disconnected" | "error"* -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-provider/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-provider/src/types.ts#L40)* ___ diff --git a/docs/rpc-rx/classes/_index_.rpcrx.md b/docs/rpc-rx/classes/_index_.rpcrx.md index 5357c61752..389b6aa058 100644 --- a/docs/rpc-rx/classes/_index_.rpcrx.md +++ b/docs/rpc-rx/classes/_index_.rpcrx.md @@ -32,7 +32,7 @@ const api = new RpcRx(provider); ⊕ **new RpcRx**(providerOrRpc?: *`Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L39)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L36)* +*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L36)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L37)* +*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L37)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L38)* +*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L38)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L39)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L59)* +*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L59)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void` -*Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/index.ts#L63)* **Parameters:** diff --git a/docs/rpc-rx/modules/_types_.md b/docs/rpc-rx/modules/_types_.md index a6eb968b99..7115d9b597 100644 --- a/docs/rpc-rx/modules/_types_.md +++ b/docs/rpc-rx/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ RpcRxInterface**: *`object`* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/types.ts#L16)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/types.ts#L14)* ___ @@ -28,7 +28,7 @@ ___ **Ƭ RpcRxInterface$Method**: *`function`* -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/types.ts#L8)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Observable`<`any`> @@ -48,7 +48,7 @@ ___ **Ƭ RpcRxInterface$Section**: *`object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/rpc-rx/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/rpc-rx/src/types.ts#L10)* #### Type declaration diff --git a/docs/type-extrinsics/modules/_frommetadata_.md b/docs/type-extrinsics/modules/_frommetadata_.md index 712bf99751..161bcad05d 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`MetadataV0`*): `ModulesWithMethods` -*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-extrinsics/src/fromMetadata.ts#L21)* +*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-extrinsics/src/fromMetadata.ts#L21)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.md b/docs/type-extrinsics/modules/_utils_createunchecked_.md index 11375ae5d2..0dc6dd1e76 100644 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.md +++ b/docs/type-extrinsics/modules/_utils_createunchecked_.md @@ -8,7 +8,7 @@ ▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `MethodFunction` -*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* +*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic. diff --git a/docs/type-jsonrpc/modules/_create_method_.md b/docs/type-jsonrpc/modules/_create_method_.md index 2d9f9d61f4..06f63b4e9b 100644 --- a/docs/type-jsonrpc/modules/_create_method_.md +++ b/docs/type-jsonrpc/modules/_create_method_.md @@ -8,7 +8,7 @@ ▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod) -*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/create/method.ts#L9)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_create_param_.md b/docs/type-jsonrpc/modules/_create_param_.md index 036b36c5fa..bd2f98a9a7 100644 --- a/docs/type-jsonrpc/modules/_create_param_.md +++ b/docs/type-jsonrpc/modules/_create_param_.md @@ -8,7 +8,7 @@ ▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam) -*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/create/param.ts#L12)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_types_.md b/docs/type-jsonrpc/modules/_types_.md index 6876b25530..0fd5470cd2 100644 --- a/docs/type-jsonrpc/modules/_types_.md +++ b/docs/type-jsonrpc/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ RpcMethod**: *`object`* -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/types.ts#L24)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RpcMethodOpt**: *`object`* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/types.ts#L13)* #### Type declaration @@ -30,7 +30,7 @@ ___ **Ƭ RpcParam**: *`object`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/types.ts#L7)* #### Type declaration @@ -41,7 +41,7 @@ ___ **Ƭ RpcSection**: *`object`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-jsonrpc/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-jsonrpc/src/types.ts#L38)* #### Type declaration diff --git a/docs/type-storage/interfaces/_types_.storage.md b/docs/type-storage/interfaces/_types_.storage.md index 4f2cd22cae..51e61672ae 100644 --- a/docs/type-storage/interfaces/_types_.storage.md +++ b/docs/type-storage/interfaces/_types_.storage.md @@ -15,7 +15,7 @@ **● substrate**: *`object`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/types.ts#L17)* #### Type declaration diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md index 17816124a9..b08eb2ce62 100644 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md @@ -12,7 +12,7 @@ **● isUnhashed**: *`undefined` | `false` | `true`* -*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/utils/createFunction.ts#L14)* +*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/utils/createFunction.ts#L14)* ___ @@ -21,7 +21,7 @@ ___ **● key**: *`undefined` | `string`* -*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/utils/createFunction.ts#L15)* +*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/utils/createFunction.ts#L15)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index 56c16c8e98..7719c9692a 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`MetadataV0`*): [Storage](../interfaces/_types_.storage.md) -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-storage/modules/_storage_.md b/docs/type-storage/modules/_storage_.md index 4645d35c3f..bb7385988b 100644 --- a/docs/type-storage/modules/_storage_.md +++ b/docs/type-storage/modules/_storage_.md @@ -8,7 +8,7 @@ **storage**: *`object`* -*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/storage.ts#L8)* @@ -16,7 +16,7 @@ **● substrate**: *["substrate"](_substrate_.md)* -*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index eb2c7e2c29..50f88e9c28 100644 --- a/docs/type-storage/modules/_substrate_.md +++ b/docs/type-storage/modules/_substrate_.md @@ -11,7 +11,7 @@ type: 'u32' }) -*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L45)* +*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L45)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L50)* +*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L50)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L60)* +*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L60)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L35)* +*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L35)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L55)* +*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L55)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/substrate.ts#L40)* +*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/substrate.ts#L40)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index e9430a0ee5..c57b5b64ab 100644 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ b/docs/type-storage/modules/_utils_createfunction_.md @@ -20,7 +20,7 @@ ▸ **createFunction**(section: *`Text` | `string`*, method: *`Text` | `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` -*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/type-storage/src/utils/createFunction.ts#L28)* +*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/type-storage/src/utils/createFunction.ts#L28)* From the schema of a function in the module's storage, generate the function that will return the correct storage key. diff --git a/docs/types/classes/_accountid_.accountid.html b/docs/types/classes/_accountid_.accountid.html index 6f046e1d6d..ca91375c69 100644 --- a/docs/types/classes/_accountid_.accountid.html +++ b/docs/types/classes/_accountid_.accountid.html @@ -2153,7 +2153,7 @@

constructor

⊕ new AccountId(value?: AnyU8a): AccountId

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2178,7 +2178,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2186,7 +2186,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2195,7 +2195,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2204,7 +2204,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2213,7 +2213,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Overrides U8a.eq

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Parameters:

@@ -2237,7 +2237,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2269,7 +2269,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2278,7 +2278,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

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

Returns: any


@@ -2287,7 +2287,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides U8a.toString

-

Defined in AccountId.ts:60

+

Defined in AccountId.ts:60

description: Returns the string representation of the value

Returns: string


@@ -2296,7 +2296,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2322,7 +2322,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2383,7 +2383,7 @@ diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md index fa4fd74752..ba961ef9e5 100644 --- a/docs/types/classes/_accountid_.accountid.md +++ b/docs/types/classes/_accountid_.accountid.md @@ -31,7 +31,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -85,7 +85,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -103,7 +103,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -120,7 +120,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -143,7 +143,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -167,7 +167,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L60)* +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_accountidof_.accountidof.md b/docs/types/classes/_accountidof_.accountidof.md index 72400f732d..376f8e846b 100644 --- a/docs/types/classes/_accountidof_.accountidof.md +++ b/docs/types/classes/_accountidof_.accountidof.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -120,7 +120,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -143,7 +143,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -167,7 +167,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -186,7 +186,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L60)* +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -222,7 +222,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -243,7 +243,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_accountindex_.accountindex.html b/docs/types/classes/_accountindex_.accountindex.html index b629bf28d1..5dbabe3275 100644 --- a/docs/types/classes/_accountindex_.accountindex.html +++ b/docs/types/classes/_accountindex_.accountindex.html @@ -2149,7 +2149,7 @@

constructor

⊕ new AccountIndex(value?: AnyNumber): AccountIndex

Overrides U32.constructor

-

Defined in AccountIndex.ts:28

+

Defined in AccountIndex.ts:28

Parameters:

@@ -2175,7 +2175,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Overrides AbstractInt.eq

-

Defined in AccountIndex.ts:87

+

Defined in AccountIndex.ts:87

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

Parameters:

@@ -2200,7 +2200,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2209,7 +2209,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides AbstractInt.toJSON

-

Defined in AccountIndex.ts:100

+

Defined in AccountIndex.ts:100

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

Returns: any


@@ -2218,7 +2218,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides AbstractInt.toString

-

Defined in AccountIndex.ts:107

+

Defined in AccountIndex.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2228,7 +2228,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2254,7 +2254,7 @@

<Static> calcLength

▸ calcLength(_value: BN | number): number

-

Defined in AccountIndex.ts:47

+

Defined in AccountIndex.ts:47

Parameters:

@@ -2276,7 +2276,7 @@

<Static> decodeAccountIndex

▸ decodeAccountIndex(value: AnyNumber): BN | Uint8Array | number | string

-

Defined in AccountIndex.ts:35

+

Defined in AccountIndex.ts:35

Parameters:

@@ -2297,7 +2297,7 @@

<Static> readLength

▸ readLength(input: Uint8Array): [number, number]

-

Defined in AccountIndex.ts:61

+

Defined in AccountIndex.ts:61

Parameters:

@@ -2318,7 +2318,7 @@

<Static> writeLength

▸ writeLength(input: Uint8Array): Uint8Array

-

Defined in AccountIndex.ts:75

+

Defined in AccountIndex.ts:75

Parameters:

@@ -2379,7 +2379,7 @@ diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md index b54a1de8d1..eb4f85598d 100644 --- a/docs/types/classes/_accountindex_.accountindex.md +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -24,7 +24,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L28)* +*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L28)* **Parameters:** @@ -48,7 +48,7 @@ ___ *Overrides AbstractInt.eq* -*Defined in [AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L87)* +*Defined in [AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L87)* *__description__*: Compares the value of the input to see if there is a match @@ -73,7 +73,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -90,7 +90,7 @@ ___ *Overrides AbstractInt.toJSON* -*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L100)* +*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L100)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -107,7 +107,7 @@ ___ *Overrides AbstractInt.toString* -*Defined in [AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L107)* +*Defined in [AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L107)* *__description__*: Returns the string representation of the value @@ -126,7 +126,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -145,7 +145,7 @@ ___ ▸ **calcLength**(_value: *`BN` | `number`*): `number` -*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L47)* +*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L47)* **Parameters:** @@ -162,7 +162,7 @@ ___ ▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string` -*Defined in [AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L35)* +*Defined in [AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L35)* **Parameters:** @@ -179,7 +179,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L61)* +*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L61)* **Parameters:** @@ -196,7 +196,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L75)* +*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L75)* **Parameters:** diff --git a/docs/types/classes/_address_.address.html b/docs/types/classes/_address_.address.html index ba08c44166..191f62ad20 100644 --- a/docs/types/classes/_address_.address.html +++ b/docs/types/classes/_address_.address.html @@ -2145,7 +2145,7 @@

constructor

⊕ new Address(value?: AnyAddress): Address

Overrides Base.constructor

-

Defined in Address.ts:25

+

Defined in Address.ts:25

Parameters:

@@ -2169,14 +2169,14 @@

encodedLength

getencodedLength(): number

-

Defined in Address.ts:67

+

Defined in Address.ts:67

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

Returns: number


rawLength

getrawLength(): number

-

Defined in Address.ts:81

+

Defined in Address.ts:81

description: The length of the raw value, either AccountIndex or AccountId

Returns: number


@@ -2184,7 +2184,7 @@

eq

▸ eq(other?: any): boolean

-

Defined in Address.ts:90

+

Defined in Address.ts:90

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

Parameters:

@@ -2206,28 +2206,28 @@

toHex

▸ toHex(): string

-

Defined in Address.ts:97

+

Defined in Address.ts:97

description: Returns a hex string representation of the value

Returns: string


toJSON

▸ toJSON(): any

-

Defined in Address.ts:104

+

Defined in Address.ts:104

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

Returns: any


toString

▸ toString(): string

-

Defined in Address.ts:111

+

Defined in Address.ts:111

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in Address.ts:119

+

Defined in Address.ts:119

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

Parameters:

@@ -2253,7 +2253,7 @@

<Static> decodeAddress

▸ decodeAddress(value: AnyAddress): AccountId | AccountIndex

-

Defined in Address.ts:32

+

Defined in Address.ts:32

Parameters:

@@ -2314,7 +2314,7 @@ diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md index 0d14a966cb..7d3e6384ff 100644 --- a/docs/types/classes/_address_.address.md +++ b/docs/types/classes/_address_.address.md @@ -20,7 +20,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L25)* +*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L25)* **Parameters:** @@ -40,7 +40,7 @@ ___ getencodedLength(): `number` -*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L67)* +*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L67)* *__description__*: The length of the value when encoded as a Uint8Array @@ -53,7 +53,7 @@ ___ getrawLength(): `number` -*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L81)* +*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L81)* *__description__*: The length of the raw value, either AccountIndex or AccountId @@ -69,7 +69,7 @@ ___ ▸ **eq**(other?: *`any`*): `boolean` -*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L90)* +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -88,7 +88,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L97)* +*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L97)* *__description__*: Returns a hex string representation of the value @@ -101,7 +101,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L104)* +*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L104)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -114,7 +114,7 @@ ___ ▸ **toString**(): `string` -*Defined in [Address.ts:111](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L111)* +*Defined in [Address.ts:111](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L111)* *__description__*: Returns the string representation of the value @@ -127,7 +127,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Address.ts:119](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L119)* +*Defined in [Address.ts:119](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L119)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -146,7 +146,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L32)* +*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L32)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.attestedcandidate.md b/docs/types/classes/_attestedcandidate_.attestedcandidate.md index dfb811bb0b..829a885226 100644 --- a/docs/types/classes/_attestedcandidate_.attestedcandidate.md +++ b/docs/types/classes/_attestedcandidate_.attestedcandidate.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AttestedCandidate.ts#L88)* +*Defined in [AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AttestedCandidate.ts#L88)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -86,7 +86,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -109,7 +109,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -130,7 +130,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -151,7 +151,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -168,7 +168,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -185,7 +185,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -202,7 +202,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -219,7 +219,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.availabilityvote.md b/docs/types/classes/_attestedcandidate_.availabilityvote.md index 4c7ad4515d..8b16bc3c24 100644 --- a/docs/types/classes/_attestedcandidate_.availabilityvote.md +++ b/docs/types/classes/_attestedcandidate_.availabilityvote.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -128,7 +128,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -153,7 +153,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -206,7 +206,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.balanceupload.md b/docs/types/classes/_attestedcandidate_.balanceupload.md index a0f4a0c18c..4cd993da86 100644 --- a/docs/types/classes/_attestedcandidate_.balanceupload.md +++ b/docs/types/classes/_attestedcandidate_.balanceupload.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -128,7 +128,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -153,7 +153,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -206,7 +206,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatereceipt.md b/docs/types/classes/_attestedcandidate_.candidatereceipt.md index ffd7911df3..35251c4f57 100644 --- a/docs/types/classes/_attestedcandidate_.candidatereceipt.md +++ b/docs/types/classes/_attestedcandidate_.candidatereceipt.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AttestedCandidate.ts#L30)* +*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AttestedCandidate.ts#L30)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -105,7 +105,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -126,7 +126,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -147,7 +147,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -164,7 +164,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -181,7 +181,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -198,7 +198,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatesignature.md b/docs/types/classes/_attestedcandidate_.candidatesignature.md index 1aab903787..573030bdde 100644 --- a/docs/types/classes/_attestedcandidate_.candidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.candidatesignature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H512.ts#L14)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.egressqueueroot.md b/docs/types/classes/_attestedcandidate_.egressqueueroot.md index c63eb6d2fc..9e09aca42c 100644 --- a/docs/types/classes/_attestedcandidate_.egressqueueroot.md +++ b/docs/types/classes/_attestedcandidate_.egressqueueroot.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -128,7 +128,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -153,7 +153,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -206,7 +206,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md index c8fbda1a1a..7fe4254f2b 100644 --- a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H512.ts#L14)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -79,7 +79,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -97,7 +97,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -114,7 +114,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -137,7 +137,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -161,7 +161,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -197,7 +197,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.headdata.md b/docs/types/classes/_attestedcandidate_.headdata.md index d059c34b77..47d8954bee 100644 --- a/docs/types/classes/_attestedcandidate_.headdata.md +++ b/docs/types/classes/_attestedcandidate_.headdata.md @@ -25,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -124,7 +124,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -148,7 +148,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -184,7 +184,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -203,7 +203,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md index 289728858c..7a4cc3b1a9 100644 --- a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H512.ts#L14)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -79,7 +79,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -97,7 +97,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -114,7 +114,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -137,7 +137,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -161,7 +161,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -197,7 +197,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.validityattestation.md b/docs/types/classes/_attestedcandidate_.validityattestation.md index 9afe1c1ff8..368562ebed 100644 --- a/docs/types/classes/_attestedcandidate_.validityattestation.md +++ b/docs/types/classes/_attestedcandidate_.validityattestation.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AttestedCandidate.ts#L54)* +*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AttestedCandidate.ts#L54)* **Parameters:** @@ -40,7 +40,7 @@ ___ getasExplicitCandidateSignature(): [ExplicitCandidateSignature](_attestedcandidate_.explicitcandidatesignature.md) -*Defined in [AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AttestedCandidate.ts#L68)* +*Defined in [AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AttestedCandidate.ts#L68)* *__description__*: Returns the item as a [ExplicitCandidateSignature](_attestedcandidate_.explicitcandidatesignature.md) @@ -53,7 +53,7 @@ ___ getasImplicitCandidateSignature(): [ImplicitCandidateSignature](_attestedcandidate_.implicitcandidatesignature.md) -*Defined in [AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AttestedCandidate.ts#L75)* +*Defined in [AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AttestedCandidate.ts#L75)* *__description__*: Returns the item as a [ImplicitCandidateSignature](_attestedcandidate_.implicitcandidatesignature.md) @@ -68,7 +68,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -83,7 +83,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -98,7 +98,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -113,7 +113,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -128,7 +128,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -143,7 +143,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -163,7 +163,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -186,7 +186,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -203,7 +203,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -218,7 +218,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -235,7 +235,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.validityvote.md b/docs/types/classes/_attestedcandidate_.validityvote.md index e32354c91c..b53be1e675 100644 --- a/docs/types/classes/_attestedcandidate_.validityvote.md +++ b/docs/types/classes/_attestedcandidate_.validityvote.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -128,7 +128,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -153,7 +153,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -206,7 +206,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_authorityid_.authorityid.html b/docs/types/classes/_authorityid_.authorityid.html index 7baa37ff4b..186d611a5b 100644 --- a/docs/types/classes/_authorityid_.authorityid.html +++ b/docs/types/classes/_authorityid_.authorityid.html @@ -2151,7 +2151,7 @@

⊕ new AuthorityId(value?: AnyU8a): AuthorityId

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2176,7 +2176,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2184,7 +2184,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2193,7 +2193,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2202,7 +2202,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2212,7 +2212,7 @@

Implementation of Codec.eq

Inherited from AccountId.eq

Overrides U8a.eq

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Parameters:

@@ -2236,7 +2236,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2268,7 +2268,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2278,7 +2278,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

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

Returns: any


@@ -2288,7 +2288,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:60

+

Defined in AccountId.ts:60

description: Returns the string representation of the value

Returns: string


@@ -2297,7 +2297,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2324,7 +2324,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2385,7 +2385,7 @@ diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md index 04356e7d17..9b8166a8f5 100644 --- a/docs/types/classes/_authorityid_.authorityid.md +++ b/docs/types/classes/_authorityid_.authorityid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -99,7 +99,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -203,7 +203,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L60)* +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_balance_.balance.html b/docs/types/classes/_balance_.balance.html index 1147cf15e4..2679bbe081 100644 --- a/docs/types/classes/_balance_.balance.html +++ b/docs/types/classes/_balance_.balance.html @@ -2151,7 +2151,7 @@

⊕ new Balance(value?: AnyNumber): Balance

Inherited from U128.constructor

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -2176,7 +2176,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2186,7 +2186,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2252,7 +2252,7 @@ diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md index 77e3d346ee..adbdb039ff 100644 --- a/docs/types/classes/_balance_.balance.md +++ b/docs/types/classes/_balance_.balance.md @@ -28,7 +28,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U128.ts#L14)* **Parameters:** @@ -54,7 +54,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -73,7 +73,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_balanceof_.balanceof.md b/docs/types/classes/_balanceof_.balanceof.md index 80fc2c706e..8ffaef12b7 100644 --- a/docs/types/classes/_balanceof_.balanceof.md +++ b/docs/types/classes/_balanceof_.balanceof.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U128.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bft_.bftauthoritysignature.html b/docs/types/classes/_bft_.bftauthoritysignature.html index 4d334a6ebe..04c7d5b1be 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.html +++ b/docs/types/classes/_bft_.bftauthoritysignature.html @@ -2151,7 +2151,7 @@

constructor

⊕ new BftAuthoritySignature(value?: BftAuthoritySignatureValue | Uint8Array): BftAuthoritySignature

Overrides Tuple.constructor

-

Defined in Bft.ts:20

+

Defined in Bft.ts:20

Parameters:

@@ -2175,14 +2175,14 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


authorityId

getauthorityId(): AuthorityId

-

Defined in Bft.ts:31

+

Defined in Bft.ts:31

description: The wrapped [[AuthoriyId]]

Returns: AuthorityId


@@ -2190,14 +2190,14 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


signature

getsignature(): Signature

-

Defined in Bft.ts:38

+

Defined in Bft.ts:38

description: The wrapped Signature value

Returns: Signature


@@ -2207,7 +2207,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2231,7 +2231,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2262,7 +2262,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2294,7 +2294,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2303,7 +2303,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2312,7 +2312,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2322,7 +2322,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2331,7 +2331,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2358,7 +2358,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md index 73038f7136..76876bb4c8 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L20)* +*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L20)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -62,7 +62,7 @@ ___ getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L31)* +*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L31)* *__description__*: The wrapped \[\[AuthoriyId\]\] @@ -77,7 +77,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -90,7 +90,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L38)* +*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L38)* *__description__*: The wrapped [Signature](_signature_.signature.md) value @@ -110,7 +110,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -133,7 +133,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -157,7 +157,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -182,7 +182,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -199,7 +199,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_bft_.bfthashsignature.html b/docs/types/classes/_bft_.bfthashsignature.html index 4144d216c7..fba6356619 100644 --- a/docs/types/classes/_bft_.bfthashsignature.html +++ b/docs/types/classes/_bft_.bfthashsignature.html @@ -2151,7 +2151,7 @@

constructor

⊕ new BftHashSignature(value?: BftHashSignatureValue | Uint8Array): BftHashSignature

Overrides Tuple.constructor

-

Defined in Bft.ts:51

+

Defined in Bft.ts:51

Parameters:

@@ -2175,7 +2175,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2183,21 +2183,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


hash

gethash(): Hash

-

Defined in Bft.ts:62

+

Defined in Bft.ts:62

description: The wrapped Hash

Returns: Hash


signature

getsignature(): Signature

-

Defined in Bft.ts:69

+

Defined in Bft.ts:69

description: The wrapped Signature

Returns: Signature


@@ -2207,7 +2207,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2231,7 +2231,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2262,7 +2262,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2294,7 +2294,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2303,7 +2303,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2312,7 +2312,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2322,7 +2322,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2331,7 +2331,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2358,7 +2358,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md index 802f6952c6..3cf537437b 100644 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L51)* +*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L51)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L62)* +*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L62)* *__description__*: The wrapped [Hash](_hash_.hash.md) @@ -90,7 +90,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L69)* +*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L69)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -110,7 +110,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -133,7 +133,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -157,7 +157,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -182,7 +182,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -199,7 +199,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_block_.block.html b/docs/types/classes/_block_.block.html index daa2967976..cfd734ff55 100644 --- a/docs/types/classes/_block_.block.html +++ b/docs/types/classes/_block_.block.html @@ -2154,7 +2154,7 @@

constructor

⊕ new Block(value?: BlockValue | Uint8Array): Block

Overrides Struct.constructor

-

Defined in Block.ts:24

+

Defined in Block.ts:24

Parameters:

@@ -2178,14 +2178,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


contentHash

getcontentHash(): Hash

-

Defined in Block.ts:35

+

Defined in Block.ts:35

description: Encodes a content Hash for the block

Returns: Hash


@@ -2193,28 +2193,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


extrinsics

getextrinsics(): Extrinsics

-

Defined in Block.ts:44

+

Defined in Block.ts:44

description: The Extrinsics contained in the block

Returns: Extrinsics


hash

gethash(): Hash

-

Defined in Block.ts:51

+

Defined in Block.ts:51

description: Block/header Hash

Returns: Hash


getheader(): Header

-

Defined in Block.ts:58

+

Defined in Block.ts:58

description: The Header of the block

Returns: Header


@@ -2224,7 +2224,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2248,7 +2248,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2273,7 +2273,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2296,7 +2296,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2305,7 +2305,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2314,7 +2314,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2323,7 +2323,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2332,7 +2332,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2359,7 +2359,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2422,7 +2422,7 @@ diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md index c9fd1ee78d..3be004f2b2 100644 --- a/docs/types/classes/_block_.block.md +++ b/docs/types/classes/_block_.block.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L24)* +*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L24)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getcontentHash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L35)* +*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L35)* *__description__*: Encodes a content [Hash](_hash_.hash.md) for the block @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) -*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L44)* +*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L44)* *__description__*: The [Extrinsics](_extrinsics_.extrinsics.md) contained in the block @@ -105,7 +105,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L51)* +*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L51)* *__description__*: Block/header [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getheader(): [Header](_header_.header.md) -*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L58)* +*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L58)* *__description__*: The [Header](_header_.header.md) of the block @@ -138,7 +138,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -161,7 +161,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -182,7 +182,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -271,7 +271,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -292,7 +292,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_blocknumber_.blocknumber.html b/docs/types/classes/_blocknumber_.blocknumber.html index aa8313b2a1..5b838fd579 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.html +++ b/docs/types/classes/_blocknumber_.blocknumber.html @@ -2150,7 +2150,7 @@

⊕ new BlockNumber(value?: AnyNumber): BlockNumber

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md index 81c64ff6eb..db44322a1e 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bool_.bool.html b/docs/types/classes/_bool_.bool.html index aeca89759c..6bbee13109 100644 --- a/docs/types/classes/_bool_.bool.html +++ b/docs/types/classes/_bool_.bool.html @@ -2148,7 +2148,7 @@

constructor

⊕ new Bool(value?: Bool | Boolean | Uint8Array | boolean | number): Bool

-

Defined in Bool.ts:15

+

Defined in Bool.ts:15

Parameters:

@@ -2182,7 +2182,7 @@

encodedLength

getencodedLength(): number

-

Defined in Bool.ts:35

+

Defined in Bool.ts:35

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

Returns: number


@@ -2191,7 +2191,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in Bool.ts:42

+

Defined in Bool.ts:42

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

Parameters:

@@ -2214,7 +2214,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Bool.ts:53

+

Defined in Bool.ts:53

description: Returns a hex string representation of the value

Returns: string


@@ -2222,7 +2222,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Bool.ts:60

+

Defined in Bool.ts:60

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

Returns: any


@@ -2230,7 +2230,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Bool.ts:67

+

Defined in Bool.ts:67

description: Returns the string representation of the value

Returns: string


@@ -2238,7 +2238,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in Bool.ts:75

+

Defined in Bool.ts:75

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

Parameters:

@@ -2304,7 +2304,7 @@ diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md index 5c470d912b..fdc356c130 100644 --- a/docs/types/classes/_bool_.bool.md +++ b/docs/types/classes/_bool_.bool.md @@ -22,7 +22,7 @@ ⊕ **new Bool**(value?: *[Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean` | `number`*): [Bool](_bool_.bool.md) -*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L15)* +*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L15)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L35)* +*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L35)* *__description__*: The length of the value when encoded as a Uint8Array @@ -72,7 +72,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L42)* +*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L42)* *__description__*: Compares the value of the input to see if there is a match @@ -93,7 +93,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Bool.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L53)* +*Defined in [Bool.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L53)* *__description__*: Returns a hex string representation of the value @@ -108,7 +108,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Bool.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L60)* +*Defined in [Bool.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L60)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -123,7 +123,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [Bool.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L67)* +*Defined in [Bool.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L67)* *__description__*: Returns the string representation of the value @@ -138,7 +138,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [Bool.ts:75](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bool.ts#L75)* +*Defined in [Bool.ts:75](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bool.ts#L75)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bytes_.bytes.html b/docs/types/classes/_bytes_.bytes.html index b81c3a5329..1c5920f7dc 100644 --- a/docs/types/classes/_bytes_.bytes.html +++ b/docs/types/classes/_bytes_.bytes.html @@ -2156,7 +2156,7 @@

constructor

⊕ new Bytes(value?: AnyU8a): Bytes

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2179,7 +2179,7 @@

encodedLength

getencodedLength(): number

Overrides U8a.encodedLength

-

Defined in Bytes.ts:61

+

Defined in Bytes.ts:61

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

Returns: number


@@ -2187,7 +2187,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2196,7 +2196,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2206,7 +2206,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2230,7 +2230,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2262,7 +2262,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2271,7 +2271,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2281,7 +2281,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2290,7 +2290,7 @@

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

Implementation of Codec.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:69

+

Defined in Bytes.ts:69

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

Parameters:

@@ -2356,7 +2356,7 @@ diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md index d8c71b9bf5..84b5acb547 100644 --- a/docs/types/classes/_bytes_.bytes.md +++ b/docs/types/classes/_bytes_.bytes.md @@ -37,7 +37,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -59,7 +59,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -74,7 +74,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -91,7 +91,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -111,7 +111,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -134,7 +134,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -158,7 +158,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -175,7 +175,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -194,7 +194,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -211,7 +211,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_chainproperties_.chainproperties.html b/docs/types/classes/_chainproperties_.chainproperties.html index 7145583273..b444dc11e4 100644 --- a/docs/types/classes/_chainproperties_.chainproperties.html +++ b/docs/types/classes/_chainproperties_.chainproperties.html @@ -2148,7 +2148,7 @@

constructor

⊕ new ChainProperties(value?: object | null): ChainProperties

-

Defined in ChainProperties.ts:17

+

Defined in ChainProperties.ts:17

Parameters:

@@ -2177,21 +2177,21 @@

encodedLength

getencodedLength(): number

-

Defined in ChainProperties.ts:29

+

Defined in ChainProperties.ts:29

description: Always 0, never encodes as a Uint8Array

Returns: number


tokenDecimals

gettokenDecimals(): number | undefined

-

Defined in ChainProperties.ts:36

+

Defined in ChainProperties.ts:36

description: The token decimals, if defined (de-facto standard only)

Returns: number | undefined


tokenSymbol

gettokenSymbol(): number | undefined

-

Defined in ChainProperties.ts:43

+

Defined in ChainProperties.ts:43

description: The token system, if defined (de-facto standard only)

Returns: number | undefined


@@ -2200,7 +2200,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in ChainProperties.ts:50

+

Defined in ChainProperties.ts:50

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

Parameters:

@@ -2223,7 +2223,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in ChainProperties.ts:57

+

Defined in ChainProperties.ts:57

description: Unimplemented, will throw

Returns: string


@@ -2231,7 +2231,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in ChainProperties.ts:64

+

Defined in ChainProperties.ts:64

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

Returns: any


@@ -2239,7 +2239,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in ChainProperties.ts:75

+

Defined in ChainProperties.ts:75

description: Returns the string representation of the value

Returns: string


@@ -2247,7 +2247,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in ChainProperties.ts:82

+

Defined in ChainProperties.ts:82

description: Unimplemented, will throw

Parameters:

@@ -2311,7 +2311,7 @@ diff --git a/docs/types/classes/_chainproperties_.chainproperties.md b/docs/types/classes/_chainproperties_.chainproperties.md index c96acb5a85..78fbc68291 100644 --- a/docs/types/classes/_chainproperties_.chainproperties.md +++ b/docs/types/classes/_chainproperties_.chainproperties.md @@ -22,7 +22,7 @@ ⊕ **new ChainProperties**(value?: *`object` | `null`*): [ChainProperties](_chainproperties_.chainproperties.md) -*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L17)* +*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L17)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L29)* +*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L29)* *__description__*: Always 0, never encodes as a Uint8Array @@ -67,7 +67,7 @@ ___ gettokenDecimals(): `number` | `undefined` -*Defined in [ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L36)* +*Defined in [ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L36)* *__description__*: The token decimals, if defined (de-facto standard only) @@ -80,7 +80,7 @@ ___ gettokenSymbol(): `number` | `undefined` -*Defined in [ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L43)* +*Defined in [ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L43)* *__description__*: The token system, if defined (de-facto standard only) @@ -98,7 +98,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L50)* +*Defined in [ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L50)* *__description__*: Compares the value of the input to see if there is a match @@ -119,7 +119,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L57)* +*Defined in [ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L57)* *__description__*: Unimplemented, will throw @@ -134,7 +134,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L64)* +*Defined in [ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L64)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -149,7 +149,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [ChainProperties.ts:75](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L75)* +*Defined in [ChainProperties.ts:75](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L75)* *__description__*: Returns the string representation of the value @@ -164,7 +164,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ChainProperties.ts#L82)* +*Defined in [ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ChainProperties.ts#L82)* *__description__*: Unimplemented, will throw diff --git a/docs/types/classes/_codec_base_.base.html b/docs/types/classes/_codec_base_.base.html index 8aa1af78ad..deb002c106 100644 --- a/docs/types/classes/_codec_base_.base.html +++ b/docs/types/classes/_codec_base_.base.html @@ -2151,7 +2151,7 @@

constructor

⊕ new Base(value?: any): Base

-

Defined in codec/Base.ts:10

+

Defined in codec/Base.ts:10

Parameters:

@@ -2212,7 +2212,7 @@ diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 616b78e75e..03d9429ce6 100644 --- a/docs/types/classes/_codec_base_.base.md +++ b/docs/types/classes/_codec_base_.base.md @@ -30,7 +30,7 @@ ⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Base.ts#L10)* +*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Base.ts#L10)* **Parameters:** diff --git a/docs/types/classes/_codec_compact_.compact.html b/docs/types/classes/_codec_compact_.compact.html index 305abc410c..3761b098e5 100644 --- a/docs/types/classes/_codec_compact_.compact.html +++ b/docs/types/classes/_codec_compact_.compact.html @@ -2150,7 +2150,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Compact.ts:23

+

Defined in codec/Compact.ts:23

Parameters:

@@ -2181,25 +2181,25 @@

<Static> addLengthPrefix

● addLengthPrefix: compactAddLength = compactAddLength

-

Defined in codec/Compact.ts:41

+

Defined in codec/Compact.ts:41

Prepend a Uint8Array with its compact length. param: The Uint8Array to be prefixed


<Static> decodeU8a

● decodeU8a: compactFromU8a = compactFromU8a

-

Defined in codec/Compact.ts:42

+

Defined in codec/Compact.ts:42


<Static> encodeU8a

● encodeU8a: compactToU8a = compactToU8a

-

Defined in codec/Compact.ts:43

+

Defined in codec/Compact.ts:43


Accessors

encodedLength

getencodedLength(): number

-

Defined in codec/Compact.ts:72

+

Defined in codec/Compact.ts:72

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

Returns: number


@@ -2207,7 +2207,7 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in codec/Compact.ts:79

+

Defined in codec/Compact.ts:79

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -2215,7 +2215,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Compact.ts:86

+

Defined in codec/Compact.ts:86

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

Parameters:

@@ -2237,7 +2237,7 @@

toBn

▸ toBn(): BN

-

Defined in codec/Compact.ts:97

+

Defined in codec/Compact.ts:97

description: Returns the BN representation of the number

Returns: BN


@@ -2245,7 +2245,7 @@

toHex

▸ toHex(): any

Implementation of Codec.toHex

-

Defined in codec/Compact.ts:104

+

Defined in codec/Compact.ts:104

description: Returns a hex string representation of the value

Returns: any


@@ -2253,14 +2253,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Compact.ts:111

+

Defined in codec/Compact.ts:111

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Compact.ts:118

+

Defined in codec/Compact.ts:118

description: Returns the number representation for the value

Returns: number


@@ -2268,7 +2268,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Compact.ts:125

+

Defined in codec/Compact.ts:125

description: Returns the string representation of the value

Returns: string


@@ -2276,7 +2276,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Compact.ts:133

+

Defined in codec/Compact.ts:133

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

Parameters:

@@ -2302,14 +2302,14 @@

unwrap

▸ unwrap(): UInt | Moment

-

Defined in codec/Compact.ts:140

+

Defined in codec/Compact.ts:140

description: Returns the embedded UInt or Moment value

Returns: UInt | Moment


<Static> decodeCompact

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

-

Defined in codec/Compact.ts:51

+

Defined in codec/Compact.ts:51

Parameters:

@@ -2336,7 +2336,7 @@

<Static> stripLengthPrefix

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

-

Defined in codec/Compact.ts:45

+

Defined in codec/Compact.ts:45

Parameters:

@@ -2364,7 +2364,7 @@

<Static> with

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

-

Defined in codec/Compact.ts:28

+

Defined in codec/Compact.ts:28

Parameters:

@@ -2426,7 +2426,7 @@ diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index a18f765d53..d28dd14c26 100644 --- a/docs/types/classes/_codec_compact_.compact.md +++ b/docs/types/classes/_codec_compact_.compact.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L23)* **Parameters:** @@ -47,7 +47,7 @@ ___ **● addLengthPrefix**: *`compactAddLength`* = compactAddLength -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. *__param__*: The Uint8Array to be prefixed @@ -59,7 +59,7 @@ ___ **● decodeU8a**: *`compactFromU8a`* = compactFromU8a -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L42)* ___ @@ -68,7 +68,7 @@ ___ **● encodeU8a**: *`compactToU8a`* = compactToU8a -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L43)* ___ @@ -80,7 +80,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -96,7 +96,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L79)* *__description__*: Returns the number of bits in the value @@ -111,7 +111,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L86)* *__description__*: Compares the value of the input to see if there is a match @@ -130,7 +130,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L97)* +*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L97)* *__description__*: Returns the BN representation of the number @@ -145,7 +145,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L104)* +*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L104)* *__description__*: Returns a hex string representation of the value @@ -160,7 +160,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L111)* +*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L111)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -173,7 +173,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L118)* +*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L118)* *__description__*: Returns the number representation for the value @@ -188,7 +188,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L125)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L125)* *__description__*: Returns the string representation of the value @@ -203,7 +203,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L133)* +*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L133)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -222,7 +222,7 @@ ___ ▸ **unwrap**(): [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md) -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L140)* +*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L140)* *__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_moment_.moment.md) value @@ -235,7 +235,7 @@ ___ ▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -253,7 +253,7 @@ ___ ▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -271,7 +271,7 @@ ___ ▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L28)* **Parameters:** diff --git a/docs/types/classes/_codec_enum_.enum.html b/docs/types/classes/_codec_enum_.enum.html index 24d723889a..4a0642ad59 100644 --- a/docs/types/classes/_codec_enum_.enum.html +++ b/docs/types/classes/_codec_enum_.enum.html @@ -2152,7 +2152,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Enum.ts:29

+

Defined in codec/Enum.ts:29

Parameters:

@@ -2184,7 +2184,7 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

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

Returns: number


@@ -2193,7 +2193,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

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

Parameters:

@@ -2216,7 +2216,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Enum.ts:84

+

Defined in codec/Enum.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2224,14 +2224,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Enum.ts:91

+

Defined in codec/Enum.ts:91

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Enum.ts:98

+

Defined in codec/Enum.ts:98

description: Returns the number representation for the value

Returns: number


@@ -2239,7 +2239,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Enum.ts:105

+

Defined in codec/Enum.ts:105

description: Returns the string representation of the value

Returns: string


@@ -2247,7 +2247,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Enum.ts:113

+

Defined in codec/Enum.ts:113

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

Parameters:

@@ -2273,7 +2273,7 @@

<Static> decodeEnum

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

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2341,7 +2341,7 @@ diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index 88dc540df6..f7c9acc4e0 100644 --- a/docs/types/classes/_codec_enum_.enum.md +++ b/docs/types/classes/_codec_enum_.enum.md @@ -30,7 +30,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L29)* +*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L29)* **Parameters:** @@ -51,7 +51,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -69,7 +69,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L71)* *__description__*: Compares the value of the input to see if there is a match @@ -90,7 +90,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L84)* +*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -105,7 +105,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -118,7 +118,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L98)* *__description__*: Returns the number representation for the value @@ -133,7 +133,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the string representation of the value @@ -148,7 +148,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L113)* +*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L113)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -167,7 +167,7 @@ ___ ▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) | `Uint8Array` | `string` | `number`*): `number` | `undefined` -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_codec_enumtype_.enumtype.html b/docs/types/classes/_codec_enumtype_.enumtype.html index e27afbad0e..07c43cfb1e 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.html +++ b/docs/types/classes/_codec_enumtype_.enumtype.html @@ -2159,7 +2159,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/EnumType.ts:35

+

Defined in codec/EnumType.ts:35

Parameters:

@@ -2190,42 +2190,42 @@

encodedLength

getencodedLength(): number

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


index

getindex(): number

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the Enum points to a Null type

Returns: boolean


isNull

getisNull(): boolean

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

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

Returns: boolean


type

gettype(): string

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

description: The name of the type this enum value represents

Returns: string


value

getvalue(): Codec

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The value of the enum

Returns: Codec


@@ -2234,7 +2234,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

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

Parameters:

@@ -2257,7 +2257,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/EnumType.ts:169

+

Defined in codec/EnumType.ts:169

description: Returns a hex string representation of the value

Returns: string


@@ -2265,14 +2265,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/EnumType.ts:185

+

Defined in codec/EnumType.ts:185

description: Returns the number representation for the value

Returns: number


@@ -2280,7 +2280,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the string representation of the value

Returns: string


@@ -2288,7 +2288,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/EnumType.ts:202

+

Defined in codec/EnumType.ts:202

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

Parameters:

@@ -2314,7 +2314,7 @@

<Static> with

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

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2377,7 +2377,7 @@ diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md index 92e88e8e18..59c6efb45c 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -42,7 +42,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/EnumType.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L35)* +*Defined in [codec/EnumType.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L35)* **Parameters:** @@ -64,7 +64,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getindex(): `number` -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -90,7 +90,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -103,7 +103,7 @@ ___ getisNull(): `boolean` -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -116,7 +116,7 @@ ___ gettype(): `string` -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -129,7 +129,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -147,7 +147,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -168,7 +168,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -183,7 +183,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -196,7 +196,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -211,7 +211,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -226,7 +226,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -245,7 +245,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_codec_int_.int.md b/docs/types/classes/_codec_int_.int.md index 2406e01338..3ede18b8f4 100644 --- a/docs/types/classes/_codec_int_.int.md +++ b/docs/types/classes/_codec_int_.int.md @@ -36,7 +36,7 @@ *Overrides AbstractInt.__constructor* -*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L21)* +*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L21)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_option_.option.html b/docs/types/classes/_codec_option_.option.html index 3ed6db4018..fc98957abf 100644 --- a/docs/types/classes/_codec_option_.option.html +++ b/docs/types/classes/_codec_option_.option.html @@ -2151,7 +2151,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Option.ts:19

+

Defined in codec/Option.ts:19

Parameters:

@@ -2177,28 +2177,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Option.ts:51

+

Defined in codec/Option.ts:51

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

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/Option.ts:59

+

Defined in codec/Option.ts:59

description: Checks if the Option has no value

Returns: boolean


isSome

getisSome(): boolean

-

Defined in codec/Option.ts:66

+

Defined in codec/Option.ts:66

description: Checks if the Option has a value

Returns: boolean


value

getvalue(): Codec

-

Defined in codec/Option.ts:73

+

Defined in codec/Option.ts:73

description: The actual value for the Option

Returns: Codec


@@ -2207,7 +2207,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Option.ts:80

+

Defined in codec/Option.ts:80

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

Parameters:

@@ -2230,7 +2230,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Option.ts:91

+

Defined in codec/Option.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2238,7 +2238,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Option.ts:98

+

Defined in codec/Option.ts:98

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

Returns: any


@@ -2246,7 +2246,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Option.ts:105

+

Defined in codec/Option.ts:105

description: Returns the string representation of the value

Returns: string


@@ -2254,7 +2254,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Option.ts:113

+

Defined in codec/Option.ts:113

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

Parameters:

@@ -2280,14 +2280,14 @@

unwrap

▸ unwrap(): T

-

Defined in codec/Option.ts:131

+

Defined in codec/Option.ts:131

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

Returns: T


unwrapOr

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

-

Defined in codec/Option.ts:143

+

Defined in codec/Option.ts:143

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

Type parameters:

O

@@ -2313,7 +2313,7 @@

<Static> decodeOption

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

-

Defined in codec/Option.ts:26

+

Defined in codec/Option.ts:26

Type parameters:

O

Parameters:

@@ -2340,7 +2340,7 @@

<Static> with

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

-

Defined in codec/Option.ts:40

+

Defined in codec/Option.ts:40

Type parameters:

O : Codec

Parameters:

@@ -2403,7 +2403,7 @@ diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md index 1134fd7b53..9622c596db 100644 --- a/docs/types/classes/_codec_option_.option.md +++ b/docs/types/classes/_codec_option_.option.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L19)* +*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L19)* **Parameters:** @@ -47,7 +47,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Option.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L51)* +*Defined in [codec/Option.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -60,7 +60,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/Option.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L59)* +*Defined in [codec/Option.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L59)* *__description__*: Checks if the Option has no value @@ -73,7 +73,7 @@ ___ getisSome(): `boolean` -*Defined in [codec/Option.ts:66](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L66)* +*Defined in [codec/Option.ts:66](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L66)* *__description__*: Checks if the Option has a value @@ -86,7 +86,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L73)* +*Defined in [codec/Option.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L73)* *__description__*: The actual value for the Option @@ -104,7 +104,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Option.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L80)* +*Defined in [codec/Option.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -125,7 +125,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Option.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L91)* +*Defined in [codec/Option.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -140,7 +140,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Option.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L98)* +*Defined in [codec/Option.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -155,7 +155,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L105)* +*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L105)* *__description__*: Returns the string representation of the value @@ -170,7 +170,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Option.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L113)* +*Defined in [codec/Option.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L113)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -189,7 +189,7 @@ ___ ▸ **unwrap**(): `T` -*Defined in [codec/Option.ts:131](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L131)* +*Defined in [codec/Option.ts:131](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L131)* *__description__*: Returns the value that the Option represents (if available), throws if null @@ -202,7 +202,7 @@ ___ ▸ **unwrapOr**<`O`>(defaultValue: *`O`*): `T` | `O` -*Defined in [codec/Option.ts:143](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L143)* +*Defined in [codec/Option.ts:143](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L143)* *__description__*: Returns the value that the Option represents (if available) or defaultValue if none @@ -224,7 +224,7 @@ ___ ▸ **decodeOption**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L26)* +*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L26)* **Type parameters:** @@ -245,7 +245,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*): [Constructor](../modules/_types_.md#constructor)<[Option](_codec_option_.option.md)<`O`>> -*Defined in [codec/Option.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Option.ts#L40)* +*Defined in [codec/Option.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Option.ts#L40)* **Type parameters:** diff --git a/docs/types/classes/_codec_set_.set.html b/docs/types/classes/_codec_set_.set.html index fb8aa3ea89..0b32850fc3 100644 --- a/docs/types/classes/_codec_set_.set.html +++ b/docs/types/classes/_codec_set_.set.html @@ -2149,7 +2149,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Set.ts:23

+

Defined in codec/Set.ts:23

Parameters:

@@ -2177,28 +2177,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Set.ts:73

+

Defined in codec/Set.ts:73

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Set.ts:80

+

Defined in codec/Set.ts:80

description: true is the Set contains no values

Returns: boolean


valueEncoded

getvalueEncoded(): number

-

Defined in codec/Set.ts:94

+

Defined in codec/Set.ts:94

description: The encoded value for the set members

Returns: number


values

getvalues(): Array<string>

-

Defined in codec/Set.ts:87

+

Defined in codec/Set.ts:87

description: The actual set values as a Array

Returns: Array<string>


@@ -2207,7 +2207,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Set.ts:101

+

Defined in codec/Set.ts:101

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

Parameters:

@@ -2230,7 +2230,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Set.ts:117

+

Defined in codec/Set.ts:117

description: Returns a hex string representation of the value

Returns: string


@@ -2238,7 +2238,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Set.ts:124

+

Defined in codec/Set.ts:124

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

Returns: any


@@ -2246,7 +2246,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Set.ts:131

+

Defined in codec/Set.ts:131

description: Returns the string representation of the value

Returns: string


@@ -2254,7 +2254,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Set.ts:139

+

Defined in codec/Set.ts:139

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

Parameters:

@@ -2280,7 +2280,7 @@

<Static> decodeSet

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

-

Defined in codec/Set.ts:33

+

Defined in codec/Set.ts:33

Parameters:

@@ -2310,7 +2310,7 @@

<Static> encodeSet

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

-

Defined in codec/Set.ts:64

+

Defined in codec/Set.ts:64

Parameters:

@@ -2375,7 +2375,7 @@ diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md index 2250b4ff61..dccada6662 100644 --- a/docs/types/classes/_codec_set_.set.md +++ b/docs/types/classes/_codec_set_.set.md @@ -24,7 +24,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L23)* +*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L23)* **Parameters:** @@ -45,7 +45,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L73)* +*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L80)* +*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L80)* *__description__*: true is the Set contains no values @@ -71,7 +71,7 @@ ___ getvalueEncoded(): `number` -*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L94)* +*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L94)* *__description__*: The encoded value for the set members @@ -84,7 +84,7 @@ ___ getvalues(): `Array`<`string`> -*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L87)* +*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L87)* *__description__*: The actual set values as a Array @@ -102,7 +102,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L101)* +*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L101)* *__description__*: Compares the value of the input to see if there is a match @@ -123,7 +123,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L117)* +*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L117)* *__description__*: Returns a hex string representation of the value @@ -138,7 +138,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L124)* +*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L124)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -153,7 +153,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L131)* +*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L131)* *__description__*: Returns the string representation of the value @@ -168,7 +168,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L139)* +*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L139)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -187,7 +187,7 @@ ___ ▸ **decodeSet**(setValues: *`SetValues`*, value?: *`Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`> -*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L33)* +*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L33)* **Parameters:** @@ -205,7 +205,7 @@ ___ ▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` -*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Set.ts#L64)* +*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Set.ts#L64)* **Parameters:** diff --git a/docs/types/classes/_codec_struct_.struct.html b/docs/types/classes/_codec_struct_.struct.html index 4a4b6169f0..27e50b7157 100644 --- a/docs/types/classes/_codec_struct_.struct.html +++ b/docs/types/classes/_codec_struct_.struct.html @@ -2199,7 +2199,7 @@

constructor

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

-

Defined in codec/Struct.ts:31

+

Defined in codec/Struct.ts:31

Parameters:

@@ -2241,14 +2241,14 @@

Type

getType(): E

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


encodedLength

getencodedLength(): number

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2257,7 +2257,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2280,7 +2280,7 @@

get

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

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2304,7 +2304,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2326,7 +2326,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2334,7 +2334,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2342,7 +2342,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2350,7 +2350,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2358,7 +2358,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2384,7 +2384,7 @@

<Static> with

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

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2447,7 +2447,7 @@ diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index 875dff1d75..8f1a6d1eee 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -119,7 +119,7 @@ ⊕ **new Struct**(Types: *`S`*, value?: *`V` | `Map`<`any`, `any`> | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md) -*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L31)* +*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L31)* **Parameters:** @@ -153,7 +153,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -166,7 +166,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -184,7 +184,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -205,7 +205,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -224,7 +224,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -243,7 +243,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -258,7 +258,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -273,7 +273,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -288,7 +288,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -303,7 +303,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -322,7 +322,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.html b/docs/types/classes/_codec_tuple_.tuple.html index f60ca66ee1..ec68d470be 100644 --- a/docs/types/classes/_codec_tuple_.tuple.html +++ b/docs/types/classes/_codec_tuple_.tuple.html @@ -2163,7 +2163,7 @@

constructor

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

-

Defined in codec/Tuple.ts:22

+

Defined in codec/Tuple.ts:22

Parameters:

@@ -2195,14 +2195,14 @@

Types

getTypes(): Array<string>

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


encodedLength

getencodedLength(): number

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


@@ -2211,7 +2211,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2234,7 +2234,7 @@

filter

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

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2264,7 +2264,7 @@

map

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

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2295,7 +2295,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2303,7 +2303,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2311,7 +2311,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2320,7 +2320,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2328,7 +2328,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2354,7 +2354,7 @@

<Static> with

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

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2415,7 +2415,7 @@ diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index 3f7f324b2b..559c90bf9a 100644 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -51,7 +51,7 @@ ⊕ **new Tuple**(Types: *`TupleConstructors`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md) -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -84,7 +84,7 @@ ___ getTypes(): `Array`<`string`> -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -97,7 +97,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -115,7 +115,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -136,7 +136,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -158,7 +158,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -181,7 +181,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -196,7 +196,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -243,7 +243,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ ▸ **with**(Types: *`TupleConstructors`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)> -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.html b/docs/types/classes/_codec_typeregistry_.typeregistry.html index 71f663e97f..36378dd6e7 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.html +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.html @@ -2141,13 +2141,13 @@

<Static> defaultRegistry

● defaultRegistry: TypeRegistry = new TypeRegistry()

-

Defined in codec/typeRegistry.ts:12

+

Defined in codec/typeRegistry.ts:12


Methods

get

▸ get(name: string): Constructor | undefined

-

Defined in codec/typeRegistry.ts:47

+

Defined in codec/typeRegistry.ts:47

Parameters:

@@ -2169,7 +2169,7 @@

register

▸ register(type: Constructor | RegistryTypes): void

▸ register(name: string, type: Constructor): void

-

Defined in codec/typeRegistry.ts:16

+

Defined in codec/typeRegistry.ts:16

Parameters:

@@ -2187,7 +2187,7 @@

Returns: void

-

Defined in codec/typeRegistry.ts:17

+

Defined in codec/typeRegistry.ts:17

Parameters:

@@ -2252,7 +2252,7 @@ diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.md b/docs/types/classes/_codec_typeregistry_.typeregistry.md index ed6ad4e0c7..a63959d32a 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.md +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.md @@ -12,7 +12,7 @@ **● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry() -*Defined in [codec/typeRegistry.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/typeRegistry.ts#L12)* +*Defined in [codec/typeRegistry.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/typeRegistry.ts#L12)* ___ @@ -24,7 +24,7 @@ ___ ▸ **get**(name: *`string`*): [Constructor](../modules/_types_.md#constructor) | `undefined` -*Defined in [codec/typeRegistry.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/typeRegistry.ts#L47)* +*Defined in [codec/typeRegistry.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/typeRegistry.ts#L47)* **Parameters:** @@ -43,7 +43,7 @@ ___ ▸ **register**(name: *`string`*, type: *[Constructor](../modules/_types_.md#constructor)*): `void` -*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/typeRegistry.ts#L16)* +*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/typeRegistry.ts#L16)* **Parameters:** @@ -53,7 +53,7 @@ ___ **Returns:** `void` -*Defined in [codec/typeRegistry.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/typeRegistry.ts#L17)* +*Defined in [codec/typeRegistry.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/typeRegistry.ts#L17)* **Parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.html b/docs/types/classes/_codec_u8a_.u8a.html index 62080bbf4d..7df51912f5 100644 --- a/docs/types/classes/_codec_u8a_.u8a.html +++ b/docs/types/classes/_codec_u8a_.u8a.html @@ -2154,7 +2154,7 @@

constructor

⊕ new U8a(value?: AnyU8a): U8a

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2182,14 +2182,14 @@

encodedLength

getencodedLength(): number

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2197,7 +2197,7 @@

length

getlength(): number

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2206,7 +2206,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2229,7 +2229,7 @@

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2260,7 +2260,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2268,7 +2268,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2277,7 +2277,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2285,7 +2285,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2351,7 +2351,7 @@ diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index 140ed3e25a..7d268532ea 100644 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ b/docs/types/classes/_codec_u8a_.u8a.md @@ -33,7 +33,7 @@ ⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md) -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L18)* **Parameters:** @@ -65,7 +65,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -78,7 +78,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -93,7 +93,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -111,7 +111,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -132,7 +132,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -154,7 +154,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -169,7 +169,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -186,7 +186,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -201,7 +201,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.html b/docs/types/classes/_codec_u8afixed_.u8afixed.html index 771b1819aa..0d3a17b1a6 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.html +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.html @@ -2157,7 +2157,7 @@

constructor

⊕ new U8aFixed(value?: AnyU8a, bitLength?: BitLength): U8aFixed

Overrides U8a.constructor

-

Defined in codec/U8aFixed.ts:19

+

Defined in codec/U8aFixed.ts:19

Parameters:

@@ -2187,7 +2187,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2195,7 +2195,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2204,7 +2204,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2212,7 +2212,7 @@

bitLength

▸ bitLength(): number

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2221,7 +2221,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2245,7 +2245,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2277,7 +2277,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2286,7 +2286,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2296,7 +2296,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2305,7 +2305,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2371,7 +2371,7 @@ diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index 611cab03ca..6aa2af3e11 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -39,7 +39,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L19)* +*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L19)* **Parameters:** @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -94,7 +94,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -110,7 +110,7 @@ ___ ▸ **bitLength**(): `number` -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -150,7 +150,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -174,7 +174,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -191,7 +191,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -210,7 +210,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_uint_.uint.html b/docs/types/classes/_codec_uint_.uint.html index e9ddc74e43..2eeaabecfe 100644 --- a/docs/types/classes/_codec_uint_.uint.html +++ b/docs/types/classes/_codec_uint_.uint.html @@ -2155,7 +2155,7 @@

constructor

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

Overrides AbstractInt.__constructor

-

Defined in codec/UInt.ts:21

+

Defined in codec/UInt.ts:21

Parameters:

@@ -2191,7 +2191,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2200,7 +2200,7 @@

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

Implementation of Codec.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2266,7 +2266,7 @@ diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index 46822727f8..1cbc385467 100644 --- a/docs/types/classes/_codec_uint_.uint.md +++ b/docs/types/classes/_codec_uint_.uint.md @@ -36,7 +36,7 @@ *Overrides AbstractInt.__constructor* -*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L21)* +*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L21)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_vector_.vector.html b/docs/types/classes/_codec_vector_.vector.html index 8c12986c0b..6c7f8f8a91 100644 --- a/docs/types/classes/_codec_vector_.vector.html +++ b/docs/types/classes/_codec_vector_.vector.html @@ -2155,7 +2155,7 @@

constructor

⊕ new Vector(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Vector

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2193,13 +2193,13 @@

Type

getType(): string

-

Defined in codec/Vector.ts:56

+

Defined in codec/Vector.ts:56

Returns: string


encodedLength

getencodedLength(): number

-

Defined in codec/Vector.ts:63

+

Defined in codec/Vector.ts:63

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

Returns: number


@@ -2207,7 +2207,7 @@

length

getlength(): number

Overrides Array.length

-

Defined in codec/Vector.ts:72

+

Defined in codec/Vector.ts:72

description: The length of the value

Returns: number


@@ -2216,7 +2216,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Vector.ts:80

+

Defined in codec/Vector.ts:80

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

Parameters:

@@ -2239,7 +2239,7 @@

filter

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

Overrides Array.filter

-

Defined in codec/Vector.ts:145

+

Defined in codec/Vector.ts:145

description: Filters the array with the callback

Parameters:

@@ -2269,7 +2269,7 @@

map

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

Overrides Array.map

-

Defined in codec/Vector.ts:154

+

Defined in codec/Vector.ts:154

description: Maps the array with the callback

Type parameters:

U

@@ -2300,7 +2300,7 @@

toArray

▸ toArray(): Array<T>

-

Defined in codec/Vector.ts:87

+

Defined in codec/Vector.ts:87

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2308,7 +2308,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Vector.ts:94

+

Defined in codec/Vector.ts:94

description: Returns a hex string representation of the value

Returns: string


@@ -2316,7 +2316,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Vector.ts:101

+

Defined in codec/Vector.ts:101

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

Returns: any


@@ -2325,7 +2325,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:110

+

Defined in codec/Vector.ts:110

description: Returns the string representation of the value

Returns: string


@@ -2333,7 +2333,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Vector.ts:123

+

Defined in codec/Vector.ts:123

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

Parameters:

@@ -2359,7 +2359,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2389,7 +2389,7 @@

<Static> with

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

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2452,7 +2452,7 @@ diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md index d715df66d0..19d8d6d3b8 100644 --- a/docs/types/classes/_codec_vector_.vector.md +++ b/docs/types/classes/_codec_vector_.vector.md @@ -33,7 +33,7 @@ ⊕ **new Vector**(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Vector](_codec_vector_.vector.md) -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -66,7 +66,7 @@ ___ getType(): `string` -*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L56)* +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L56)* **Returns:** `string` @@ -77,7 +77,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L63)* +*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L63)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L72)* *__description__*: The length of the value @@ -110,7 +110,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L80)* +*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L145)* +*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L145)* *__description__*: Filters the array with the callback @@ -153,7 +153,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L154)* +*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L154)* *__description__*: Maps the array with the callback @@ -176,7 +176,7 @@ ___ ▸ **toArray**(): `Array`<`T`> -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L87)* *__description__*: Converts the Object to an standard JavaScript Array @@ -191,7 +191,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L94)* *__description__*: Returns a hex string representation of the value @@ -206,7 +206,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L101)* +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L101)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -223,7 +223,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L110)* *__description__*: Returns the string representation of the value @@ -238,7 +238,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L123)* +*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -257,7 +257,7 @@ ___ ▸ **decodeVector**<`T`>(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -278,7 +278,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)<`O`>*): [Constructor](../modules/_types_.md#constructor)<[Vector](_codec_vector_.vector.md)<`O`>> -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_codehash_.codehash.md b/docs/types/classes/_codehash_.codehash.md index 31e7950904..1deae06433 100644 --- a/docs/types/classes/_codehash_.codehash.md +++ b/docs/types/classes/_codehash_.codehash.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_data_.data.html b/docs/types/classes/_data_.data.html index d1bf8264e7..b882be67e1 100644 --- a/docs/types/classes/_data_.data.html +++ b/docs/types/classes/_data_.data.html @@ -2151,7 +2151,7 @@

constructor

⊕ new Data(value?: AnyU8a): Data

Inherited from U8a.constructor

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2182,7 +2182,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2191,7 +2191,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2225,7 +2225,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2257,7 +2257,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2266,7 +2266,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2276,7 +2276,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2285,7 +2285,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2351,7 +2351,7 @@ diff --git a/docs/types/classes/_data_.data.md b/docs/types/classes/_data_.data.md index 7490b337b8..089295a2f2 100644 --- a/docs/types/classes/_data_.data.md +++ b/docs/types/classes/_data_.data.md @@ -27,7 +27,7 @@ *Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L18)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -124,7 +124,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -148,7 +148,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -184,7 +184,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -201,7 +201,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.authoritieschange.html b/docs/types/classes/_digest_.authoritieschange.html index 11a3c04b1d..e34b6f97f6 100644 --- a/docs/types/classes/_digest_.authoritieschange.html +++ b/docs/types/classes/_digest_.authoritieschange.html @@ -2153,7 +2153,7 @@

constructor

⊕ new AuthoritiesChange(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): AuthoritiesChange

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2186,14 +2186,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:56

+

Defined in codec/Vector.ts:56

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:63

+

Defined in codec/Vector.ts:63

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

Returns: number


@@ -2202,7 +2202,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:72

+

Defined in codec/Vector.ts:72

description: The length of the value

Returns: number


@@ -2212,7 +2212,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

-

Defined in codec/Vector.ts:80

+

Defined in codec/Vector.ts:80

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

Parameters:

@@ -2236,7 +2236,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:145

+

Defined in codec/Vector.ts:145

description: Filters the array with the callback

Parameters:

@@ -2267,7 +2267,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:154

+

Defined in codec/Vector.ts:154

description: Maps the array with the callback

Type parameters:

U

@@ -2299,7 +2299,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:87

+

Defined in codec/Vector.ts:87

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2308,7 +2308,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:94

+

Defined in codec/Vector.ts:94

description: Returns a hex string representation of the value

Returns: string


@@ -2317,7 +2317,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:101

+

Defined in codec/Vector.ts:101

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

Returns: any


@@ -2327,7 +2327,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:110

+

Defined in codec/Vector.ts:110

description: Returns the string representation of the value

Returns: string


@@ -2336,7 +2336,7 @@

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

Implementation of Codec.toU8a

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:123

+

Defined in codec/Vector.ts:123

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

Parameters:

@@ -2363,7 +2363,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2394,7 +2394,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2457,7 +2457,7 @@ diff --git a/docs/types/classes/_digest_.authoritieschange.md b/docs/types/classes/_digest_.authoritieschange.md index 0e52aff832..a136dbc3d3 100644 --- a/docs/types/classes/_digest_.authoritieschange.md +++ b/docs/types/classes/_digest_.authoritieschange.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L56)* +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L56)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L63)* +*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L63)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L72)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L80)* +*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -125,7 +125,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L145)* +*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L145)* *__description__*: Filters the array with the callback @@ -149,7 +149,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L154)* +*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L154)* *__description__*: Maps the array with the callback @@ -174,7 +174,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L87)* *__description__*: Converts the Object to an standard JavaScript Array @@ -191,7 +191,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L94)* *__description__*: Returns a hex string representation of the value @@ -208,7 +208,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L101)* +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L101)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -227,7 +227,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L110)* *__description__*: Returns the string representation of the value @@ -244,7 +244,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L123)* +*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -265,7 +265,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_digest_.changestrieroot.html b/docs/types/classes/_digest_.changestrieroot.html index 761c08a29b..85a036475d 100644 --- a/docs/types/classes/_digest_.changestrieroot.html +++ b/docs/types/classes/_digest_.changestrieroot.html @@ -2152,7 +2152,7 @@

⊕ new ChangesTrieRoot(value?: AnyU8a): ChangesTrieRoot

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2175,7 +2175,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2183,7 +2183,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2192,7 +2192,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2234,7 +2234,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2266,7 +2266,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2275,7 +2275,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2285,7 +2285,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2294,7 +2294,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_digest_.changestrieroot.md b/docs/types/classes/_digest_.changestrieroot.md index db8231667b..abce33c01b 100644 --- a/docs/types/classes/_digest_.changestrieroot.md +++ b/docs/types/classes/_digest_.changestrieroot.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.digest.html b/docs/types/classes/_digest_.digest.html index 2c1417b6d1..623d03d4df 100644 --- a/docs/types/classes/_digest_.digest.html +++ b/docs/types/classes/_digest_.digest.html @@ -2154,7 +2154,7 @@

constructor

⊕ new Digest(value: any): Digest

Overrides Struct.constructor

-

Defined in Digest.ts:117

+

Defined in Digest.ts:117

Parameters:

@@ -2177,7 +2177,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2185,14 +2185,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


logs

getlogs(): Vector<DigestItem>

-

Defined in Digest.ts:127

+

Defined in Digest.ts:127

description: The DigestItem logs

Returns: Vector<DigestItem>


@@ -2202,7 +2202,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2226,7 +2226,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2251,7 +2251,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2274,7 +2274,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2283,7 +2283,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2292,7 +2292,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2301,7 +2301,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2310,7 +2310,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2337,7 +2337,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2400,7 +2400,7 @@ diff --git a/docs/types/classes/_digest_.digest.md b/docs/types/classes/_digest_.digest.md index 1956478451..0319935fe2 100644 --- a/docs/types/classes/_digest_.digest.md +++ b/docs/types/classes/_digest_.digest.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Digest.ts:117](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L117)* +*Defined in [Digest.ts:117](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L117)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> -*Defined in [Digest.ts:127](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L127)* +*Defined in [Digest.ts:127](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L127)* *__description__*: The [DigestItem](_digest_.digestitem.md) logs @@ -99,7 +99,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -122,7 +122,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -143,7 +143,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -164,7 +164,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -181,7 +181,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -198,7 +198,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_digest_.digestitem.html b/docs/types/classes/_digest_.digestitem.html index 140737406c..3a9a7ab542 100644 --- a/docs/types/classes/_digest_.digestitem.html +++ b/docs/types/classes/_digest_.digestitem.html @@ -2149,7 +2149,7 @@

constructor

⊕ new DigestItem(value: any): DigestItem

Overrides EnumType.constructor

-

Defined in Digest.ts:73

+

Defined in Digest.ts:73

Parameters:

@@ -2171,28 +2171,28 @@

asAuthoritiesChange

getasAuthoritiesChange(): AuthoritiesChange

-

Defined in Digest.ts:86

+

Defined in Digest.ts:86

description: Returns the item as a AuthoritiesChange

Returns: AuthoritiesChange


asChangesTrieRoot

getasChangesTrieRoot(): ChangesTrieRoot

-

Defined in Digest.ts:93

+

Defined in Digest.ts:93

description: Returns the item as a ChangesTrieRoot

Returns: ChangesTrieRoot


asOther

getasOther(): Other

-

Defined in Digest.ts:100

+

Defined in Digest.ts:100

description: Returns the item as a Other

Returns: Other


asSeal

getasSeal(): Seal

-

Defined in Digest.ts:107

+

Defined in Digest.ts:107

description: Returns the item as a Seal

Returns: Seal


@@ -2200,7 +2200,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


@@ -2208,7 +2208,7 @@

index

getindex(): number

Inherited from EnumType.index

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


@@ -2216,7 +2216,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2224,7 +2224,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

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

Returns: boolean


@@ -2232,7 +2232,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

description: The name of the type this enum value represents

Returns: string


@@ -2240,7 +2240,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The value of the enum

Returns: Codec


@@ -2250,7 +2250,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

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

Parameters:

@@ -2274,7 +2274,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:169

+

Defined in codec/EnumType.ts:169

description: Returns a hex string representation of the value

Returns: string


@@ -2283,7 +2283,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

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

Returns: any


@@ -2291,7 +2291,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:185

+

Defined in codec/EnumType.ts:185

description: Returns the number representation for the value

Returns: number


@@ -2300,7 +2300,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the string representation of the value

Returns: string


@@ -2309,7 +2309,7 @@

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

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:202

+

Defined in codec/EnumType.ts:202

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

Parameters:

@@ -2336,7 +2336,7 @@

<Static> with

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

Inherited from EnumType.with

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2399,7 +2399,7 @@ diff --git a/docs/types/classes/_digest_.digestitem.md b/docs/types/classes/_digest_.digestitem.md index 644d85dd7c..b1ad6a7c00 100644 --- a/docs/types/classes/_digest_.digestitem.md +++ b/docs/types/classes/_digest_.digestitem.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L73)* +*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L73)* **Parameters:** @@ -44,7 +44,7 @@ ___ getasAuthoritiesChange(): [AuthoritiesChange](_digest_.authoritieschange.md) -*Defined in [Digest.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L86)* +*Defined in [Digest.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L86)* *__description__*: Returns the item as a [AuthoritiesChange](_digest_.authoritieschange.md) @@ -57,7 +57,7 @@ ___ getasChangesTrieRoot(): [ChangesTrieRoot](_digest_.changestrieroot.md) -*Defined in [Digest.ts:93](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L93)* +*Defined in [Digest.ts:93](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L93)* *__description__*: Returns the item as a [ChangesTrieRoot](_digest_.changestrieroot.md) @@ -70,7 +70,7 @@ ___ getasOther(): [Other](_digest_.other.md) -*Defined in [Digest.ts:100](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L100)* +*Defined in [Digest.ts:100](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L100)* *__description__*: Returns the item as a [Other](_digest_.other.md) @@ -83,7 +83,7 @@ ___ getasSeal(): [Seal](_digest_.seal.md) -*Defined in [Digest.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L107)* +*Defined in [Digest.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L107)* *__description__*: Returns the item as a [Seal](_digest_.seal.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -128,7 +128,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -143,7 +143,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -158,7 +158,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -173,7 +173,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -193,7 +193,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -216,7 +216,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -233,7 +233,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -248,7 +248,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -265,7 +265,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -282,7 +282,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -303,7 +303,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_digest_.other.html b/docs/types/classes/_digest_.other.html index 4e8b186edf..752f9e140b 100644 --- a/docs/types/classes/_digest_.other.html +++ b/docs/types/classes/_digest_.other.html @@ -2152,7 +2152,7 @@

⊕ new Other(value?: AnyU8a): Other

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2176,7 +2176,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:61

+

Defined in Bytes.ts:61

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

Returns: number


@@ -2184,7 +2184,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2193,7 +2193,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2203,7 +2203,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2227,7 +2227,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2268,7 +2268,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2278,7 +2278,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2288,7 +2288,7 @@

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:69

+

Defined in Bytes.ts:69

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

Parameters:

@@ -2354,7 +2354,7 @@ diff --git a/docs/types/classes/_digest_.other.md b/docs/types/classes/_digest_.other.md index 63d9fc4185..332f36b386 100644 --- a/docs/types/classes/_digest_.other.md +++ b/docs/types/classes/_digest_.other.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -85,7 +85,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -105,7 +105,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -128,7 +128,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -152,7 +152,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -169,7 +169,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -188,7 +188,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -207,7 +207,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.seal.html b/docs/types/classes/_digest_.seal.html index 39c2fe8b93..7e2c27b8e6 100644 --- a/docs/types/classes/_digest_.seal.html +++ b/docs/types/classes/_digest_.seal.html @@ -2151,7 +2151,7 @@

constructor

⊕ new Seal(value: any): Seal

Overrides Tuple.constructor

-

Defined in Digest.ts:44

+

Defined in Digest.ts:44

Parameters:

@@ -2174,7 +2174,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2182,21 +2182,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


signature

getsignature(): Signature

-

Defined in Digest.ts:55

+

Defined in Digest.ts:55

description: The wrapped Signature

Returns: Signature


slot

getslot(): U64

-

Defined in Digest.ts:62

+

Defined in Digest.ts:62

description: The wrapped U64 slot

Returns: U64


@@ -2206,7 +2206,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2230,7 +2230,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2261,7 +2261,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2293,7 +2293,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2302,7 +2302,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2311,7 +2311,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2321,7 +2321,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2330,7 +2330,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2357,7 +2357,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2418,7 +2418,7 @@ diff --git a/docs/types/classes/_digest_.seal.md b/docs/types/classes/_digest_.seal.md index 31a2b11b20..19e49285ab 100644 --- a/docs/types/classes/_digest_.seal.md +++ b/docs/types/classes/_digest_.seal.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L44)* +*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L44)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L55)* +*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L55)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -90,7 +90,7 @@ ___ getslot(): [U64](_u64_.u64.md) -*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Digest.ts#L62)* +*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Digest.ts#L62)* *__description__*: The wrapped [U64](_u64_.u64.md) slot @@ -110,7 +110,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -133,7 +133,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -157,7 +157,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -182,7 +182,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -199,7 +199,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_event_.event.html b/docs/types/classes/_event_.event.html index b919c9d87f..48eb8ba481 100644 --- a/docs/types/classes/_event_.event.html +++ b/docs/types/classes/_event_.event.html @@ -2154,7 +2154,7 @@

constructor

⊕ new Event(value?: *[Uint8Array](_codec_u8a.u8a.md#uint8array)*): Event

Overrides Struct.constructor

-

Defined in Event.ts:86

+

Defined in Event.ts:86

Parameters:

@@ -2177,14 +2177,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


data

getdata(): EventData

-

Defined in Event.ts:144

+

Defined in Event.ts:144

description: The wrapped EventData

Returns: EventData


@@ -2192,42 +2192,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


index

getindex(): EventIndex

-

Defined in Event.ts:151

+

Defined in Event.ts:151

description: The EventIndex, identifying the raw event

Returns: EventIndex


meta

getmeta(): EventMetadata

-

Defined in Event.ts:158

+

Defined in Event.ts:158

description: The EventMetadata with the documentation

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:165

+

Defined in Event.ts:165

description: The method string identifying the event

Returns: string


section

getsection(): string

-

Defined in Event.ts:172

+

Defined in Event.ts:172

description: The section string identifying the event

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:179

+

Defined in Event.ts:179

description: The TypeDef for the event

Returns: Array<TypeDef>


@@ -2237,7 +2237,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2261,7 +2261,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2286,7 +2286,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2309,7 +2309,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2318,7 +2318,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2327,7 +2327,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2336,7 +2336,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2345,7 +2345,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2371,7 +2371,7 @@

<Static> decodeEvent

▸ decodeEvent(value?: Uint8Array): object | object

-

Defined in Event.ts:98

+

Defined in Event.ts:98

Parameters:

@@ -2394,7 +2394,7 @@

<Static> injectMetadata

▸ injectMetadata(metadata: MetadataV0): void

-

Defined in Event.ts:122

+

Defined in Event.ts:122

Parameters:

@@ -2416,7 +2416,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2479,7 +2479,7 @@ diff --git a/docs/types/classes/_event_.event.md b/docs/types/classes/_event_.event.md index cecf394f71..ea097af0f5 100644 --- a/docs/types/classes/_event_.event.md +++ b/docs/types/classes/_event_.event.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L86)* +*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L86)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdata(): [EventData](_event_.eventdata.md) -*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L144)* +*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L144)* *__description__*: The wrapped [EventData](_event_.eventdata.md) @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getindex(): [EventIndex](_event_.eventindex.md) -*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L151)* +*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L151)* *__description__*: The [EventIndex](_event_.eventindex.md), identifying the raw event @@ -105,7 +105,7 @@ ___ getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) -*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L158)* +*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L158)* *__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) with the documentation @@ -118,7 +118,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L165)* +*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L165)* *__description__*: The method string identifying the event @@ -131,7 +131,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L172)* +*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L172)* *__description__*: The section string identifying the event @@ -144,7 +144,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L179)* +*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L179)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event @@ -164,7 +164,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -187,7 +187,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -208,7 +208,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -263,7 +263,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -280,7 +280,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -316,7 +316,7 @@ ___ ▸ **decodeEvent**(value?: *`Uint8Array`*): `object` | `object` -*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L98)* +*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L98)* **Parameters:** @@ -333,7 +333,7 @@ ___ ▸ **injectMetadata**(metadata: *[MetadataV0](_metadata_v0_index_.metadatav0.md)*): `void` -*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L122)* +*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L122)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_event_.eventdata.html b/docs/types/classes/_event_.eventdata.html index 00c2b79d29..0fd4ac3776 100644 --- a/docs/types/classes/_event_.eventdata.html +++ b/docs/types/classes/_event_.eventdata.html @@ -2151,7 +2151,7 @@

constructor

⊕ new EventData(Types: Array<Constructor>, value: Uint8Array, typeDef: Array<TypeDef>, meta: EventMetadata, section: string, method: string): EventData

Overrides Tuple.constructor

-

Defined in Event.ts:28

+

Defined in Event.ts:28

Parameters:

@@ -2194,7 +2194,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2202,35 +2202,35 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


meta

getmeta(): EventMetadata

-

Defined in Event.ts:42

+

Defined in Event.ts:42

description: The wrapped EventMetadata

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:49

+

Defined in Event.ts:49

description: The method as a string

Returns: string


section

getsection(): string

-

Defined in Event.ts:56

+

Defined in Event.ts:56

description: The section as a string

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:63

+

Defined in Event.ts:63

description: The TypeDef for this event

Returns: Array<TypeDef>


@@ -2240,7 +2240,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2264,7 +2264,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2295,7 +2295,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2327,7 +2327,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2336,7 +2336,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2345,7 +2345,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2355,7 +2355,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2364,7 +2364,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2391,7 +2391,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2452,7 +2452,7 @@ diff --git a/docs/types/classes/_event_.eventdata.md b/docs/types/classes/_event_.eventdata.md index 16e0c96fc1..edf8755b26 100644 --- a/docs/types/classes/_event_.eventdata.md +++ b/docs/types/classes/_event_.eventdata.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L28)* +*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L28)* **Parameters:** @@ -54,7 +54,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) -*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L42)* +*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L42)* *__description__*: The wrapped [EventMetadata](_metadata_v0_events_.eventmetadata.md) @@ -95,7 +95,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L49)* +*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L49)* *__description__*: The method as a string @@ -108,7 +108,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L56)* +*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L56)* *__description__*: The section as a string @@ -121,7 +121,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L63)* +*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L63)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event @@ -141,7 +141,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -164,7 +164,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -188,7 +188,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -213,7 +213,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -230,7 +230,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -247,7 +247,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -266,7 +266,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -283,7 +283,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -304,7 +304,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_event_.eventindex.html b/docs/types/classes/_event_.eventindex.html index 07e437586f..937f75cf35 100644 --- a/docs/types/classes/_event_.eventindex.html +++ b/docs/types/classes/_event_.eventindex.html @@ -2151,7 +2151,7 @@

constructor

⊕ new EventIndex(value?: any): EventIndex

Overrides U8aFixed.constructor

-

Defined in Event.ts:74

+

Defined in Event.ts:74

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2182,7 +2182,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2191,7 +2191,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2200,7 +2200,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2209,7 +2209,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2233,7 +2233,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2265,7 +2265,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2274,7 +2274,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2284,7 +2284,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2293,7 +2293,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2359,7 +2359,7 @@ diff --git a/docs/types/classes/_event_.eventindex.md b/docs/types/classes/_event_.eventindex.md index 01ac8aa3f0..da2a277e4a 100644 --- a/docs/types/classes/_event_.eventindex.md +++ b/docs/types/classes/_event_.eventindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Event.ts#L74)* +*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Event.ts#L74)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -99,7 +99,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -116,7 +116,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -139,7 +139,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -163,7 +163,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -199,7 +199,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.html b/docs/types/classes/_eventrecord_.applyextrinsic.html index a781539a3c..f075c81f91 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.html +++ b/docs/types/classes/_eventrecord_.applyextrinsic.html @@ -2150,7 +2150,7 @@

⊕ new ApplyExtrinsic(value?: AnyNumber): ApplyExtrinsic

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.md b/docs/types/classes/_eventrecord_.applyextrinsic.md index e356136b3e..3877c3c3ca 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.md +++ b/docs/types/classes/_eventrecord_.applyextrinsic.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.eventrecord.html b/docs/types/classes/_eventrecord_.eventrecord.html index 31f221962b..649bc71c79 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.html +++ b/docs/types/classes/_eventrecord_.eventrecord.html @@ -2154,7 +2154,7 @@

constructor

⊕ new EventRecord(value: any): EventRecord

Overrides Struct.constructor

-

Defined in EventRecord.ts:61

+

Defined in EventRecord.ts:61

Parameters:

@@ -2177,7 +2177,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2185,21 +2185,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


event

getevent(): Event

-

Defined in EventRecord.ts:72

+

Defined in EventRecord.ts:72

description: The Event this record refers to

Returns: Event


phase

getphase(): Phase

-

Defined in EventRecord.ts:79

+

Defined in EventRecord.ts:79

description: The Phase where the event was generated

Returns: Phase


@@ -2209,7 +2209,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2233,7 +2233,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2258,7 +2258,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2281,7 +2281,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2290,7 +2290,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2299,7 +2299,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2308,7 +2308,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2317,7 +2317,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2344,7 +2344,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2407,7 +2407,7 @@ diff --git a/docs/types/classes/_eventrecord_.eventrecord.md b/docs/types/classes/_eventrecord_.eventrecord.md index 5fa0f7d77c..f89b58c751 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.md +++ b/docs/types/classes/_eventrecord_.eventrecord.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [EventRecord.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L61)* +*Defined in [EventRecord.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L61)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getevent(): [Event](_event_.event.md) -*Defined in [EventRecord.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L72)* +*Defined in [EventRecord.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L72)* *__description__*: The [Event](_event_.event.md) this record refers to @@ -92,7 +92,7 @@ ___ getphase(): [Phase](_eventrecord_.phase.md) -*Defined in [EventRecord.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L79)* +*Defined in [EventRecord.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L79)* *__description__*: The [Phase](_eventrecord_.phase.md) where the event was generated @@ -112,7 +112,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -135,7 +135,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -156,7 +156,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -245,7 +245,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_eventrecord_.finalization.html b/docs/types/classes/_eventrecord_.finalization.html index df6583ce71..bdd2f75b99 100644 --- a/docs/types/classes/_eventrecord_.finalization.html +++ b/docs/types/classes/_eventrecord_.finalization.html @@ -2149,7 +2149,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:17

+

Defined in Null.ts:17

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

Returns: number


@@ -2159,7 +2159,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

-

Defined in Null.ts:24

+

Defined in Null.ts:24

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

Parameters:

@@ -2183,7 +2183,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:31

+

Defined in Null.ts:31

description: Returns a hex string representation of the value

Returns: string


@@ -2192,7 +2192,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:38

+

Defined in Null.ts:38

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

Returns: any


@@ -2201,7 +2201,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Returns the string representation of the value

Returns: string


@@ -2210,7 +2210,7 @@

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

Implementation of Codec.toU8a

Inherited from Null.toU8a

-

Defined in Null.ts:53

+

Defined in Null.ts:53

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

Parameters:

@@ -2276,7 +2276,7 @@ diff --git a/docs/types/classes/_eventrecord_.finalization.md b/docs/types/classes/_eventrecord_.finalization.md index 8cb3b93431..063c590194 100644 --- a/docs/types/classes/_eventrecord_.finalization.md +++ b/docs/types/classes/_eventrecord_.finalization.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -67,7 +67,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -101,7 +101,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -118,7 +118,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.phase.html b/docs/types/classes/_eventrecord_.phase.html index cc9c63e991..d1fd9069a1 100644 --- a/docs/types/classes/_eventrecord_.phase.html +++ b/docs/types/classes/_eventrecord_.phase.html @@ -2149,7 +2149,7 @@

constructor

⊕ new Phase(value: any, index?: undefined | number): Phase

Overrides EnumType.constructor

-

Defined in EventRecord.ts:32

+

Defined in EventRecord.ts:32

Parameters:

@@ -2176,14 +2176,14 @@

asApplyExtrinsic

getasApplyExtrinsic(): ApplyExtrinsic

-

Defined in EventRecord.ts:43

+

Defined in EventRecord.ts:43

description: Returns the item as a ApplyExtrinsic

Returns: ApplyExtrinsic


asFinalization

getasFinalization(): Finalization

-

Defined in EventRecord.ts:50

+

Defined in EventRecord.ts:50

description: Returns the item as a Finalization

Returns: Finalization


@@ -2191,7 +2191,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


@@ -2199,7 +2199,7 @@

index

getindex(): number

Inherited from EnumType.index

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


@@ -2207,7 +2207,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2215,7 +2215,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

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

Returns: boolean


@@ -2223,7 +2223,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

description: The name of the type this enum value represents

Returns: string


@@ -2231,7 +2231,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The value of the enum

Returns: Codec


@@ -2241,7 +2241,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

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

Parameters:

@@ -2265,7 +2265,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:169

+

Defined in codec/EnumType.ts:169

description: Returns a hex string representation of the value

Returns: string


@@ -2274,7 +2274,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

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

Returns: any


@@ -2282,7 +2282,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:185

+

Defined in codec/EnumType.ts:185

description: Returns the number representation for the value

Returns: number


@@ -2291,7 +2291,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the string representation of the value

Returns: string


@@ -2300,7 +2300,7 @@

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

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:202

+

Defined in codec/EnumType.ts:202

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

Parameters:

@@ -2327,7 +2327,7 @@

<Static> with

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

Inherited from EnumType.with

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2390,7 +2390,7 @@ diff --git a/docs/types/classes/_eventrecord_.phase.md b/docs/types/classes/_eventrecord_.phase.md index e4d4225779..e0efdec2ee 100644 --- a/docs/types/classes/_eventrecord_.phase.md +++ b/docs/types/classes/_eventrecord_.phase.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L32)* +*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L32)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasApplyExtrinsic(): [ApplyExtrinsic](_eventrecord_.applyextrinsic.md) -*Defined in [EventRecord.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L43)* +*Defined in [EventRecord.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L43)* *__description__*: Returns the item as a [ApplyExtrinsic](_eventrecord_.applyextrinsic.md) @@ -58,7 +58,7 @@ ___ getasFinalization(): [Finalization](_eventrecord_.finalization.md) -*Defined in [EventRecord.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/EventRecord.ts#L50)* +*Defined in [EventRecord.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/EventRecord.ts#L50)* *__description__*: Returns the item as a [Finalization](_eventrecord_.finalization.md) @@ -73,7 +73,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -103,7 +103,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -118,7 +118,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -133,7 +133,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -148,7 +148,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -168,7 +168,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -191,7 +191,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -208,7 +208,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -223,7 +223,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -240,7 +240,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -257,7 +257,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -278,7 +278,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_extrinsic_.extrinsic.html b/docs/types/classes/_extrinsic_.extrinsic.html index 7fbf5c3019..ebfb5be473 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.html +++ b/docs/types/classes/_extrinsic_.extrinsic.html @@ -2160,7 +2160,7 @@

constructor

⊕ new Extrinsic(value?: ExtrinsicValue | AnyU8a | Method): Extrinsic

Overrides Struct.constructor

-

Defined in Extrinsic.ts:36

+

Defined in Extrinsic.ts:36

Parameters:

@@ -2185,28 +2185,28 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Extrinsic.ts:76

+

Defined in Extrinsic.ts:76

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

Returns: Array<Codec>


callIndex

getcallIndex(): Uint8Array

-

Defined in Extrinsic.ts:83

+

Defined in Extrinsic.ts:83

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

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Extrinsic.ts:90

+

Defined in Extrinsic.ts:90

description: The actual data for the Method

Returns: Uint8Array


@@ -2214,49 +2214,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in Extrinsic.ts:97

+

Defined in Extrinsic.ts:97

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

Returns: number


hash

gethash(): Hash

-

Defined in Extrinsic.ts:106

+

Defined in Extrinsic.ts:106

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

Returns: Hash


isSigned

getisSigned(): boolean

-

Defined in Extrinsic.ts:115

+

Defined in Extrinsic.ts:115

description: true id the extrinsic is signed

Returns: boolean


length

getlength(): number

-

Defined in Extrinsic.ts:122

+

Defined in Extrinsic.ts:122

description: The length of the encoded value

Returns: number


meta

getmeta(): FunctionMetadata

-

Defined in Extrinsic.ts:129

+

Defined in Extrinsic.ts:129

description: The FunctionMetadata that describes the extrinsic

Returns: FunctionMetadata


method

getmethod(): Method

-

Defined in Extrinsic.ts:136

+

Defined in Extrinsic.ts:136

description: The Method this extrinsic wraps

Returns: Method


signature

getsignature(): ExtrinsicSignature

-

Defined in Extrinsic.ts:143

+

Defined in Extrinsic.ts:143

description: The ExtrinsicSignature

Returns: ExtrinsicSignature


@@ -2264,7 +2264,7 @@

addSignature

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

-

Defined in Extrinsic.ts:150

+

Defined in Extrinsic.ts:150

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

Parameters:

@@ -2301,7 +2301,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2325,7 +2325,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2350,7 +2350,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2372,7 +2372,7 @@

sign

▸ sign(account: KeyringPair, options: SignatureOptions): Extrinsic

-

Defined in Extrinsic.ts:159

+

Defined in Extrinsic.ts:159

description: Sign the extrinsic with a specific keypair

Parameters:

@@ -2399,7 +2399,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2408,7 +2408,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides Struct.toHex

-

Defined in Extrinsic.ts:168

+

Defined in Extrinsic.ts:168

description: Returns a hex string representation of the value

Returns: string


@@ -2417,7 +2417,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Struct.toJSON

-

Defined in Extrinsic.ts:175

+

Defined in Extrinsic.ts:175

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

Returns: any


@@ -2426,7 +2426,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2435,7 +2435,7 @@

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

Implementation of Codec.toU8a

Overrides Struct.toU8a

-

Defined in Extrinsic.ts:183

+

Defined in Extrinsic.ts:183

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

Parameters:

@@ -2461,7 +2461,7 @@

<Static> decodeExtrinsic

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

-

Defined in Extrinsic.ts:44

+

Defined in Extrinsic.ts:44

Parameters:

@@ -2485,7 +2485,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2548,7 +2548,7 @@ diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md index 0569d5cfc8..5f54936459 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -36,7 +36,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L36)* +*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L36)* **Parameters:** @@ -58,7 +58,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -71,7 +71,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L76)* +*Defined in [Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L76)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_method_.method.md) @@ -84,7 +84,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L83)* +*Defined in [Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L83)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -97,7 +97,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L90)* +*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L90)* *__description__*: The actual data for the Method @@ -112,7 +112,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L97)* +*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -125,7 +125,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L106)* +*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L106)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -138,7 +138,7 @@ ___ getisSigned(): `boolean` -*Defined in [Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L115)* +*Defined in [Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L115)* *__description__*: `true` id the extrinsic is signed @@ -151,7 +151,7 @@ ___ getlength(): `number` -*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L122)* +*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L122)* *__description__*: The length of the encoded value @@ -164,7 +164,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) -*Defined in [Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L129)* +*Defined in [Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L129)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) that describes the extrinsic @@ -177,7 +177,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L136)* +*Defined in [Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L136)* *__description__*: The [Method](_method_.method.md) this extrinsic wraps @@ -190,7 +190,7 @@ ___ getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L143)* +*Defined in [Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L143)* *__description__*: The [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -206,7 +206,7 @@ ___ ▸ **addSignature**(signer: *[Address](_address_.address.md) | `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L150)* +*Defined in [Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L150)* *__description__*: Add an [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated) @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -255,7 +255,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -276,7 +276,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -295,7 +295,7 @@ ___ ▸ **sign**(account: *`KeyringPair`*, options: *[SignatureOptions](../modules/_extrinsicsignature_.md#signatureoptions)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L159)* +*Defined in [Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L159)* *__description__*: Sign the extrinsic with a specific keypair @@ -317,7 +317,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -334,7 +334,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L168)* +*Defined in [Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L168)* *__description__*: Returns a hex string representation of the value @@ -351,7 +351,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L175)* +*Defined in [Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L175)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -368,7 +368,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -385,7 +385,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L183)* +*Defined in [Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L183)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -404,7 +404,7 @@ ___ ▸ **decodeExtrinsic**(value: *`ExtrinsicValue` | [AnyU8a](../modules/_types_.md#anyu8a) | [Method](_method_.method.md)*): `ExtrinsicValue` | `Array`<`number`> | `Uint8Array` -*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Extrinsic.ts#L44)* +*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -423,7 +423,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.html b/docs/types/classes/_extrinsicera_.extrinsicera.html index ddea64c3d8..437ac603de 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.html +++ b/docs/types/classes/_extrinsicera_.extrinsicera.html @@ -2151,7 +2151,7 @@

constructor

⊕ new ExtrinsicEra(value?: AnyU8a): ExtrinsicEra

Overrides U8a.constructor

-

Defined in ExtrinsicEra.ts:16

+

Defined in ExtrinsicEra.ts:16

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2182,7 +2182,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2191,7 +2191,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2225,7 +2225,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2257,7 +2257,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2266,7 +2266,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2276,7 +2276,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2285,7 +2285,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2311,7 +2311,7 @@

<Static> decodeExtrinsicEra

▸ decodeExtrinsicEra(value?: AnyU8a): Uint8Array

-

Defined in ExtrinsicEra.ts:23

+

Defined in ExtrinsicEra.ts:23

Parameters:

@@ -2372,7 +2372,7 @@ diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md index 606df88aa7..2b394cacd3 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_extrinsicera_.extrinsicera.md @@ -27,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicEra.ts#L16)* +*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicEra.ts#L16)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -124,7 +124,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -148,7 +148,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -184,7 +184,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -201,7 +201,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -220,7 +220,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array` -*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicEra.ts#L23)* +*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicEra.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_extrinsics_.extrinsics.html b/docs/types/classes/_extrinsics_.extrinsics.html index d3feac9f6c..972dfe4f90 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.html +++ b/docs/types/classes/_extrinsics_.extrinsics.html @@ -2154,7 +2154,7 @@

constructor

⊕ new Extrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Extrinsics

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2187,14 +2187,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:56

+

Defined in codec/Vector.ts:56

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:63

+

Defined in codec/Vector.ts:63

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

Returns: number


@@ -2203,7 +2203,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:72

+

Defined in codec/Vector.ts:72

description: The length of the value

Returns: number


@@ -2213,7 +2213,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

-

Defined in codec/Vector.ts:80

+

Defined in codec/Vector.ts:80

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

Parameters:

@@ -2237,7 +2237,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:145

+

Defined in codec/Vector.ts:145

description: Filters the array with the callback

Parameters:

@@ -2268,7 +2268,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:154

+

Defined in codec/Vector.ts:154

description: Maps the array with the callback

Type parameters:

U

@@ -2300,7 +2300,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:87

+

Defined in codec/Vector.ts:87

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2309,7 +2309,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:94

+

Defined in codec/Vector.ts:94

description: Returns a hex string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:101

+

Defined in codec/Vector.ts:101

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

Returns: any


@@ -2328,7 +2328,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:110

+

Defined in codec/Vector.ts:110

description: Returns the string representation of the value

Returns: string


@@ -2337,7 +2337,7 @@

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

Implementation of Codec.toU8a

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:123

+

Defined in codec/Vector.ts:123

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

Parameters:

@@ -2364,7 +2364,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2395,7 +2395,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2458,7 +2458,7 @@ diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md index 1c2d057878..31c9ba99f9 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -31,7 +31,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L56)* +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L56)* **Returns:** `string` @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L63)* +*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L63)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L72)* *__description__*: The length of the value @@ -104,7 +104,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L80)* +*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -127,7 +127,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L145)* +*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L145)* *__description__*: Filters the array with the callback @@ -151,7 +151,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L154)* +*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L154)* *__description__*: Maps the array with the callback @@ -176,7 +176,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L87)* *__description__*: Converts the Object to an standard JavaScript Array @@ -193,7 +193,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L94)* *__description__*: Returns a hex string representation of the value @@ -210,7 +210,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L101)* +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L101)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -229,7 +229,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L110)* *__description__*: Returns the string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L123)* +*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -267,7 +267,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -290,7 +290,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html index c21f0ecbe9..f4dddcf099 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html @@ -2154,7 +2154,7 @@

constructor

⊕ new ExtrinsicSignature(value?: Uint8Array): ExtrinsicSignature

Overrides Struct.constructor

-

Defined in ExtrinsicSignature.ts:36

+

Defined in ExtrinsicSignature.ts:36

Parameters:

@@ -2177,7 +2177,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2185,49 +2185,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in ExtrinsicSignature.ts:73

+

Defined in ExtrinsicSignature.ts:73

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

Returns: number


era

getera(): ExtrinsicEra

-

Defined in ExtrinsicSignature.ts:89

+

Defined in ExtrinsicSignature.ts:89

description: The ExtrinsicEra (mortal or immortal) this signature applies to

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in ExtrinsicSignature.ts:82

+

Defined in ExtrinsicSignature.ts:82

description: true if the signature is valid

Returns: boolean


nonce

getnonce(): Nonce

-

Defined in ExtrinsicSignature.ts:96

+

Defined in ExtrinsicSignature.ts:96

description: The Nonce for the signature

Returns: Nonce


signature

getsignature(): Signature

-

Defined in ExtrinsicSignature.ts:103

+

Defined in ExtrinsicSignature.ts:103

description: The actuall Signature hash

Returns: Signature


signer

getsigner(): Address

-

Defined in ExtrinsicSignature.ts:110

+

Defined in ExtrinsicSignature.ts:110

description: The Address that signed

Returns: Address


version

getversion(): number

-

Defined in ExtrinsicSignature.ts:117

+

Defined in ExtrinsicSignature.ts:117

description: The encoded version for the signature

Returns: number


@@ -2235,7 +2235,7 @@

addSignature

▸ addSignature(signer: *[Address](_address.address.md) | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array*): ExtrinsicSignature

-

Defined in ExtrinsicSignature.ts:138

+

Defined in ExtrinsicSignature.ts:138

description: Adds a raw signature

Parameters:

@@ -2277,7 +2277,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2301,7 +2301,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2326,7 +2326,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2348,7 +2348,7 @@

sign

▸ sign(method: Method, account: KeyringPair, _namedParameters: object): [ExtrinsicSignature](_extrinsicsignature.extrinsicsignature.md)

-

Defined in ExtrinsicSignature.ts:150

+

Defined in ExtrinsicSignature.ts:150

description: Generate a payload and pplies the signature from a keypair

Parameters:

@@ -2379,7 +2379,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2388,7 +2388,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2397,7 +2397,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2406,7 +2406,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2415,7 +2415,7 @@

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

Implementation of Codec.toU8a

Overrides Struct.toU8a

-

Defined in ExtrinsicSignature.ts:167

+

Defined in ExtrinsicSignature.ts:167

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

Parameters:

@@ -2441,7 +2441,7 @@

<Static> decodeExtrinsicSignature

▸ decodeExtrinsicSignature(value?: Uint8Array): object | Uint8Array

-

Defined in ExtrinsicSignature.ts:53

+

Defined in ExtrinsicSignature.ts:53

Parameters:

@@ -2463,7 +2463,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2526,7 +2526,7 @@ diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md index 129728fe52..39a15a36b9 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L36)* +*Defined in [ExtrinsicSignature.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L36)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L73)* +*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L89)* +*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L89)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to @@ -92,7 +92,7 @@ ___ getisSigned(): `boolean` -*Defined in [ExtrinsicSignature.ts:82](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L82)* +*Defined in [ExtrinsicSignature.ts:82](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L82)* *__description__*: `true` if the signature is valid @@ -105,7 +105,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L96)* +*Defined in [ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L96)* *__description__*: The [Nonce](_nonce_.nonce.md) for the signature @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [ExtrinsicSignature.ts:103](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L103)* +*Defined in [ExtrinsicSignature.ts:103](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L103)* *__description__*: The actuall [Signature](_signature_.signature.md) hash @@ -131,7 +131,7 @@ ___ getsigner(): [Address](_address_.address.md) -*Defined in [ExtrinsicSignature.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L110)* +*Defined in [ExtrinsicSignature.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L110)* *__description__*: The [Address](_address_.address.md) that signed @@ -144,7 +144,7 @@ ___ getversion(): `number` -*Defined in [ExtrinsicSignature.ts:117](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L117)* +*Defined in [ExtrinsicSignature.ts:117](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L117)* *__description__*: The encoded version for the signature @@ -160,7 +160,7 @@ ___ ▸ **addSignature**(_signer: *[Address](_address_.address.md) | `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:138](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L138)* +*Defined in [ExtrinsicSignature.ts:138](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L138)* *__description__*: Adds a raw signature @@ -186,7 +186,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -209,7 +209,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -230,7 +230,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -249,7 +249,7 @@ ___ ▸ **sign**(method: *[Method](_method_.method.md)*, account: *`KeyringPair`*, __namedParameters: *`object`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:150](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L150)* +*Defined in [ExtrinsicSignature.ts:150](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L150)* *__description__*: Generate a payload and pplies the signature from a keypair @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -289,7 +289,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -306,7 +306,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -340,7 +340,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [ExtrinsicSignature.ts:167](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L167)* +*Defined in [ExtrinsicSignature.ts:167](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L167)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -359,7 +359,7 @@ ___ ▸ **decodeExtrinsicSignature**(value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): `object` | `Uint8Array` -*Defined in [ExtrinsicSignature.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L53)* +*Defined in [ExtrinsicSignature.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L53)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.html b/docs/types/classes/_extrinsicstatus_.broadcast.html index da06453e68..5546687234 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.html +++ b/docs/types/classes/_extrinsicstatus_.broadcast.html @@ -2153,7 +2153,7 @@

constructor

⊕ new Broadcast(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Broadcast

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2186,14 +2186,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:56

+

Defined in codec/Vector.ts:56

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:63

+

Defined in codec/Vector.ts:63

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

Returns: number


@@ -2202,7 +2202,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:72

+

Defined in codec/Vector.ts:72

description: The length of the value

Returns: number


@@ -2212,7 +2212,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

-

Defined in codec/Vector.ts:80

+

Defined in codec/Vector.ts:80

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

Parameters:

@@ -2236,7 +2236,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:145

+

Defined in codec/Vector.ts:145

description: Filters the array with the callback

Parameters:

@@ -2267,7 +2267,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:154

+

Defined in codec/Vector.ts:154

description: Maps the array with the callback

Type parameters:

U

@@ -2299,7 +2299,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:87

+

Defined in codec/Vector.ts:87

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2308,7 +2308,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:94

+

Defined in codec/Vector.ts:94

description: Returns a hex string representation of the value

Returns: string


@@ -2317,7 +2317,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:101

+

Defined in codec/Vector.ts:101

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

Returns: any


@@ -2327,7 +2327,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:110

+

Defined in codec/Vector.ts:110

description: Returns the string representation of the value

Returns: string


@@ -2336,7 +2336,7 @@

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

Implementation of Codec.toU8a

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:123

+

Defined in codec/Vector.ts:123

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

Parameters:

@@ -2363,7 +2363,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2394,7 +2394,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2457,7 +2457,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.md b/docs/types/classes/_extrinsicstatus_.broadcast.md index 947eb98409..8a9732cd18 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_extrinsicstatus_.broadcast.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L56)* +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L56)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L63)* +*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L63)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L72)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L80)* +*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -125,7 +125,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L145)* +*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L145)* *__description__*: Filters the array with the callback @@ -149,7 +149,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L154)* +*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L154)* *__description__*: Maps the array with the callback @@ -174,7 +174,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L87)* *__description__*: Converts the Object to an standard JavaScript Array @@ -191,7 +191,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L94)* *__description__*: Returns a hex string representation of the value @@ -208,7 +208,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L101)* +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L101)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -227,7 +227,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L110)* *__description__*: Returns the string representation of the value @@ -244,7 +244,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L123)* +*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -265,7 +265,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.dropped.html b/docs/types/classes/_extrinsicstatus_.dropped.html index d2dca57dde..0c96e2d991 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.html +++ b/docs/types/classes/_extrinsicstatus_.dropped.html @@ -2149,7 +2149,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:17

+

Defined in Null.ts:17

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

Returns: number


@@ -2159,7 +2159,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

-

Defined in Null.ts:24

+

Defined in Null.ts:24

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

Parameters:

@@ -2183,7 +2183,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:31

+

Defined in Null.ts:31

description: Returns a hex string representation of the value

Returns: string


@@ -2192,7 +2192,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:38

+

Defined in Null.ts:38

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

Returns: any


@@ -2201,7 +2201,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Returns the string representation of the value

Returns: string


@@ -2210,7 +2210,7 @@

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

Implementation of Codec.toU8a

Inherited from Null.toU8a

-

Defined in Null.ts:53

+

Defined in Null.ts:53

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

Parameters:

@@ -2276,7 +2276,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.dropped.md b/docs/types/classes/_extrinsicstatus_.dropped.md index 8d7b0b64ca..dfd22fca57 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.md +++ b/docs/types/classes/_extrinsicstatus_.dropped.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -67,7 +67,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -101,7 +101,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -118,7 +118,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html index bb8c8a6bca..5541434bfd 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html @@ -2149,7 +2149,7 @@

constructor

⊕ new ExtrinsicStatus(value: any, index?: undefined | number): ExtrinsicStatus

Overrides EnumType.constructor

-

Defined in ExtrinsicStatus.ts:72

+

Defined in ExtrinsicStatus.ts:72

Parameters:

@@ -2176,49 +2176,49 @@

asBroadcast

getasBroadcast(): Broadcast

-

Defined in ExtrinsicStatus.ts:88

+

Defined in ExtrinsicStatus.ts:88

description: Returns the item as a Broadcast

Returns: Broadcast


asDropped

getasDropped(): Dropped

-

Defined in ExtrinsicStatus.ts:95

+

Defined in ExtrinsicStatus.ts:95

description: Returns the item as a Dropped

Returns: Dropped


asFinalised

getasFinalised(): Finalised

-

Defined in ExtrinsicStatus.ts:102

+

Defined in ExtrinsicStatus.ts:102

description: Returns the item as a Finalised

Returns: Finalised


asFuture

getasFuture(): Future

-

Defined in ExtrinsicStatus.ts:109

+

Defined in ExtrinsicStatus.ts:109

description: Returns the item as a Future

Returns: Future


asInvalid

getasInvalid(): Invalid

-

Defined in ExtrinsicStatus.ts:116

+

Defined in ExtrinsicStatus.ts:116

description: Returns the item as a Invalid

Returns: Invalid


asReady

getasReady(): Ready

-

Defined in ExtrinsicStatus.ts:123

+

Defined in ExtrinsicStatus.ts:123

description: Returns the item as a Ready

Returns: Ready


asUsurped

getasUsurped(): Usurped

-

Defined in ExtrinsicStatus.ts:130

+

Defined in ExtrinsicStatus.ts:130

description: Returns the item as a Usurped

Returns: Usurped


@@ -2226,7 +2226,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


@@ -2234,7 +2234,7 @@

index

getindex(): number

Inherited from EnumType.index

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


@@ -2242,7 +2242,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2250,7 +2250,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

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

Returns: boolean


@@ -2258,7 +2258,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

description: The name of the type this enum value represents

Returns: string


@@ -2266,7 +2266,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The value of the enum

Returns: Codec


@@ -2276,7 +2276,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

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

Parameters:

@@ -2300,7 +2300,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:169

+

Defined in codec/EnumType.ts:169

description: Returns a hex string representation of the value

Returns: string


@@ -2309,7 +2309,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

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

Returns: any


@@ -2317,7 +2317,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:185

+

Defined in codec/EnumType.ts:185

description: Returns the number representation for the value

Returns: number


@@ -2326,7 +2326,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the string representation of the value

Returns: string


@@ -2335,7 +2335,7 @@

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

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:202

+

Defined in codec/EnumType.ts:202

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

Parameters:

@@ -2362,7 +2362,7 @@

<Static> with

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

Inherited from EnumType.with

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2425,7 +2425,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md index c65db95f79..b7475b0004 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L72)* +*Defined in [ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L72)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasBroadcast(): [Broadcast](_extrinsicstatus_.broadcast.md) -*Defined in [ExtrinsicStatus.ts:88](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L88)* +*Defined in [ExtrinsicStatus.ts:88](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L88)* *__description__*: Returns the item as a [Broadcast](_extrinsicstatus_.broadcast.md) @@ -58,7 +58,7 @@ ___ getasDropped(): [Dropped](_extrinsicstatus_.dropped.md) -*Defined in [ExtrinsicStatus.ts:95](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L95)* +*Defined in [ExtrinsicStatus.ts:95](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L95)* *__description__*: Returns the item as a [Dropped](_extrinsicstatus_.dropped.md) @@ -71,7 +71,7 @@ ___ getasFinalised(): [Finalised](_extrinsicstatus_.finalised.md) -*Defined in [ExtrinsicStatus.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L102)* +*Defined in [ExtrinsicStatus.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L102)* *__description__*: Returns the item as a [Finalised](_extrinsicstatus_.finalised.md) @@ -84,7 +84,7 @@ ___ getasFuture(): [Future](_extrinsicstatus_.future.md) -*Defined in [ExtrinsicStatus.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L109)* +*Defined in [ExtrinsicStatus.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L109)* *__description__*: Returns the item as a [Future](_extrinsicstatus_.future.md) @@ -97,7 +97,7 @@ ___ getasInvalid(): [Invalid](_extrinsicstatus_.invalid.md) -*Defined in [ExtrinsicStatus.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L116)* +*Defined in [ExtrinsicStatus.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L116)* *__description__*: Returns the item as a [Invalid](_extrinsicstatus_.invalid.md) @@ -110,7 +110,7 @@ ___ getasReady(): [Ready](_extrinsicstatus_.ready.md) -*Defined in [ExtrinsicStatus.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L123)* +*Defined in [ExtrinsicStatus.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L123)* *__description__*: Returns the item as a [Ready](_extrinsicstatus_.ready.md) @@ -123,7 +123,7 @@ ___ getasUsurped(): [Usurped](_extrinsicstatus_.usurped.md) -*Defined in [ExtrinsicStatus.ts:130](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicStatus.ts#L130)* +*Defined in [ExtrinsicStatus.ts:130](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicStatus.ts#L130)* *__description__*: Returns the item as a [Usurped](_extrinsicstatus_.usurped.md) @@ -138,7 +138,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -153,7 +153,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -168,7 +168,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -183,7 +183,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -198,7 +198,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -213,7 +213,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -233,7 +233,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -256,7 +256,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -273,7 +273,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -288,7 +288,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -305,7 +305,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -322,7 +322,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -343,7 +343,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.finalised.html b/docs/types/classes/_extrinsicstatus_.finalised.html index 58103a7447..ce234f4302 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.html +++ b/docs/types/classes/_extrinsicstatus_.finalised.html @@ -2152,7 +2152,7 @@

⊕ new Finalised(value?: AnyU8a): Finalised

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2175,7 +2175,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2183,7 +2183,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2192,7 +2192,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2234,7 +2234,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2266,7 +2266,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2275,7 +2275,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2285,7 +2285,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2294,7 +2294,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.finalised.md b/docs/types/classes/_extrinsicstatus_.finalised.md index 0c354c415f..c5966ba324 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_extrinsicstatus_.finalised.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.future.md b/docs/types/classes/_extrinsicstatus_.future.md index 0fdde8aa49..89a1ad1061 100644 --- a/docs/types/classes/_extrinsicstatus_.future.md +++ b/docs/types/classes/_extrinsicstatus_.future.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -67,7 +67,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -101,7 +101,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -118,7 +118,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.invalid.md b/docs/types/classes/_extrinsicstatus_.invalid.md index bc8540d476..62dd19f6a6 100644 --- a/docs/types/classes/_extrinsicstatus_.invalid.md +++ b/docs/types/classes/_extrinsicstatus_.invalid.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -67,7 +67,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -101,7 +101,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -118,7 +118,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.ready.md b/docs/types/classes/_extrinsicstatus_.ready.md index 4ff8a60b9e..0832299d08 100644 --- a/docs/types/classes/_extrinsicstatus_.ready.md +++ b/docs/types/classes/_extrinsicstatus_.ready.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -67,7 +67,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -101,7 +101,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -118,7 +118,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.usurped.html b/docs/types/classes/_extrinsicstatus_.usurped.html index 197a67a9c9..e56801f0c0 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.html +++ b/docs/types/classes/_extrinsicstatus_.usurped.html @@ -2152,7 +2152,7 @@

⊕ new Usurped(value?: AnyU8a): Usurped

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2175,7 +2175,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2183,7 +2183,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2192,7 +2192,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2234,7 +2234,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2266,7 +2266,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2275,7 +2275,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2285,7 +2285,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2294,7 +2294,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.usurped.md b/docs/types/classes/_extrinsicstatus_.usurped.md index 34e0349c52..b301f6aa15 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_extrinsicstatus_.usurped.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_gas_.gas.html b/docs/types/classes/_gas_.gas.html index 4caedce66e..c34d74c617 100644 --- a/docs/types/classes/_gas_.gas.html +++ b/docs/types/classes/_gas_.gas.html @@ -2150,7 +2150,7 @@

⊕ new Gas(value?: AnyNumber): Gas

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md index 1fef963722..64e0e11cde 100644 --- a/docs/types/classes/_gas_.gas.md +++ b/docs/types/classes/_gas_.gas.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_h256_.h256.html b/docs/types/classes/_h256_.h256.html index d6bde78d98..ff8772824f 100644 --- a/docs/types/classes/_h256_.h256.html +++ b/docs/types/classes/_h256_.h256.html @@ -2152,7 +2152,7 @@

constructor

⊕ new H256(value?: AnyU8a): H256

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2175,7 +2175,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2183,7 +2183,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2192,7 +2192,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2234,7 +2234,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2266,7 +2266,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2275,7 +2275,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2285,7 +2285,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2294,7 +2294,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md index a5cd98a8da..52f0fb6557 100644 --- a/docs/types/classes/_h256_.h256.md +++ b/docs/types/classes/_h256_.h256.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_h512_.h512.html b/docs/types/classes/_h512_.h512.html index c722ca82c6..29be3bb848 100644 --- a/docs/types/classes/_h512_.h512.html +++ b/docs/types/classes/_h512_.h512.html @@ -2152,7 +2152,7 @@

constructor

⊕ new H512(value?: AnyU8a): H512

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2183,7 +2183,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2192,7 +2192,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2201,7 +2201,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2234,7 +2234,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2266,7 +2266,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2275,7 +2275,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2285,7 +2285,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2294,7 +2294,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md index 510f8a9826..b31e9b372d 100644 --- a/docs/types/classes/_h512_.h512.md +++ b/docs/types/classes/_h512_.h512.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H512.ts#L14)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_hash_.hash.html b/docs/types/classes/_hash_.hash.html index 7db43b0477..8ec87264bf 100644 --- a/docs/types/classes/_hash_.hash.html +++ b/docs/types/classes/_hash_.hash.html @@ -2157,7 +2157,7 @@

⊕ new Hash(value?: AnyU8a): Hash

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2180,7 +2180,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2188,7 +2188,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2197,7 +2197,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2206,7 +2206,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2215,7 +2215,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2239,7 +2239,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2271,7 +2271,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2280,7 +2280,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2290,7 +2290,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2299,7 +2299,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2365,7 +2365,7 @@ diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md index 811db20b58..bc1d17e67d 100644 --- a/docs/types/classes/_hash_.hash.md +++ b/docs/types/classes/_hash_.hash.md @@ -39,7 +39,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -76,7 +76,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -93,7 +93,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -111,7 +111,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -128,7 +128,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -151,7 +151,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -175,7 +175,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -192,7 +192,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -211,7 +211,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -228,7 +228,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_header_.header.html b/docs/types/classes/_header_.header.html index fb92864e8c..8921d04a17 100644 --- a/docs/types/classes/_header_.header.html +++ b/docs/types/classes/_header_.header.html @@ -2155,7 +2155,7 @@

constructor

⊕ new Header(value?: HeaderValue | Uint8Array): Header

Overrides Struct.constructor

-

Defined in Header.ts:30

+

Defined in Header.ts:30

Parameters:

@@ -2179,21 +2179,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockNumber

getblockNumber(): BlockNumber

-

Defined in Header.ts:44

+

Defined in Header.ts:44

description: The wrapped BlockNumber

Returns: BlockNumber


digest

getdigest(): Digest

-

Defined in Header.ts:51

+

Defined in Header.ts:51

description: The wrapped Digest

Returns: Digest


@@ -2201,35 +2201,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


extrinsicsRoot

getextrinsicsRoot(): Hash

-

Defined in Header.ts:58

+

Defined in Header.ts:58

description: The wrapped extrisics root as a Hash

Returns: Hash


hash

gethash(): Hash

-

Defined in Header.ts:65

+

Defined in Header.ts:65

description: Convenience method, encodes the header and calculates the Hash

Returns: Hash


parentHash

getparentHash(): Hash

-

Defined in Header.ts:74

+

Defined in Header.ts:74

description: The wrapped parent as a Hash

Returns: Hash


stateRoot

getstateRoot(): Hash

-

Defined in Header.ts:81

+

Defined in Header.ts:81

description: The wrapped state root as a Hash

Returns: Hash


@@ -2239,7 +2239,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2263,7 +2263,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2288,7 +2288,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2311,7 +2311,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2320,7 +2320,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2329,7 +2329,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2338,7 +2338,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2347,7 +2347,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2374,7 +2374,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2437,7 +2437,7 @@ diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md index 65016d3952..97bf0af032 100644 --- a/docs/types/classes/_header_.header.md +++ b/docs/types/classes/_header_.header.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Header.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L30)* +*Defined in [Header.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L30)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ ___ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [Header.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L44)* +*Defined in [Header.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L44)* *__description__*: The wrapped [BlockNumber](_blocknumber_.blocknumber.md) @@ -79,7 +79,7 @@ ___ getdigest(): [Digest](_digest_.digest.md) -*Defined in [Header.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L51)* +*Defined in [Header.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L51)* *__description__*: The wrapped [Digest](_digest_.digest.md) @@ -94,7 +94,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -107,7 +107,7 @@ ___ getextrinsicsRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L58)* +*Defined in [Header.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L58)* *__description__*: The wrapped extrisics root as a [Hash](_hash_.hash.md) @@ -120,7 +120,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L65)* +*Defined in [Header.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L65)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_hash_.hash.md) @@ -133,7 +133,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L74)* +*Defined in [Header.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L74)* *__description__*: The wrapped parent as a [Hash](_hash_.hash.md) @@ -146,7 +146,7 @@ ___ getstateRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:81](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L81)* +*Defined in [Header.ts:81](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L81)* *__description__*: The wrapped state root as a [Hash](_hash_.hash.md) @@ -166,7 +166,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -189,7 +189,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -248,7 +248,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -265,7 +265,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -282,7 +282,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -299,7 +299,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -320,7 +320,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_header_.headerextended.md b/docs/types/classes/_header_.headerextended.md index 3fe09b42b7..227d6a8dcc 100644 --- a/docs/types/classes/_header_.headerextended.md +++ b/docs/types/classes/_header_.headerextended.md @@ -29,7 +29,7 @@ *Overrides [Header](_header_.header.md).[constructor](_header_.header.md#constructor)* -*Defined in [Header.ts:92](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L92)* +*Defined in [Header.ts:92](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L92)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -65,7 +65,7 @@ ___ getauthor(): [AccountId](_accountid_.accountid.md) | `undefined` -*Defined in [Header.ts:108](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L108)* +*Defined in [Header.ts:108](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L108)* *__description__*: Convenience method, returns the author for the block @@ -80,7 +80,7 @@ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) *Inherited from [Header](_header_.header.md).[blockNumber](_header_.header.md#blocknumber)* -*Defined in [Header.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L44)* +*Defined in [Header.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L44)* *__description__*: The wrapped [BlockNumber](_blocknumber_.blocknumber.md) @@ -95,7 +95,7 @@ getdigest(): [Digest](_digest_.digest.md) *Inherited from [Header](_header_.header.md).[digest](_header_.header.md#digest)* -*Defined in [Header.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L51)* +*Defined in [Header.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L51)* *__description__*: The wrapped [Digest](_digest_.digest.md) @@ -110,7 +110,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -125,7 +125,7 @@ getextrinsicsRoot(): [Hash](_hash_.hash.md) *Inherited from [Header](_header_.header.md).[extrinsicsRoot](_header_.header.md#extrinsicsroot)* -*Defined in [Header.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L58)* +*Defined in [Header.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L58)* *__description__*: The wrapped extrisics root as a [Hash](_hash_.hash.md) @@ -140,7 +140,7 @@ gethash(): [Hash](_hash_.hash.md) *Inherited from [Header](_header_.header.md).[hash](_header_.header.md#hash)* -*Defined in [Header.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L65)* +*Defined in [Header.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L65)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_hash_.hash.md) @@ -155,7 +155,7 @@ getparentHash(): [Hash](_hash_.hash.md) *Inherited from [Header](_header_.header.md).[parentHash](_header_.header.md#parenthash)* -*Defined in [Header.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L74)* +*Defined in [Header.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L74)* *__description__*: The wrapped parent as a [Hash](_hash_.hash.md) @@ -170,7 +170,7 @@ getstateRoot(): [Hash](_hash_.hash.md) *Inherited from [Header](_header_.header.md).[stateRoot](_header_.header.md#stateroot)* -*Defined in [Header.ts:81](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L81)* +*Defined in [Header.ts:81](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L81)* *__description__*: The wrapped state root as a [Hash](_hash_.hash.md) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -213,7 +213,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -234,7 +234,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -255,7 +255,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -289,7 +289,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -306,7 +306,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -344,7 +344,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_health_.health.md b/docs/types/classes/_health_.health.md index edb15ef0ff..ae31c1d1e5 100644 --- a/docs/types/classes/_health_.health.md +++ b/docs/types/classes/_health_.health.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Health.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Health.ts#L19)* +*Defined in [Health.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Health.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getisSyncing(): [Bool](_bool_.bool.md) -*Defined in [Health.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Health.ts#L31)* +*Defined in [Health.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Health.ts#L31)* *__description__*: The sync status @@ -92,7 +92,7 @@ ___ getpeers(): [USize](_usize_.usize.md) -*Defined in [Health.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Health.ts#L38)* +*Defined in [Health.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Health.ts#L38)* *__description__*: The numbers of peers as [U32](_u32_.u32.md) @@ -105,7 +105,7 @@ ___ getshouldHavePeers(): [Bool](_bool_.bool.md) -*Defined in [Health.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Health.ts#L45)* +*Defined in [Health.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Health.ts#L45)* *__description__*: Should this node have peers (not active on --dev) @@ -125,7 +125,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -148,7 +148,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -169,7 +169,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_i128_.i128.md b/docs/types/classes/_i128_.i128.md index 4623263c76..82396065c2 100644 --- a/docs/types/classes/_i128_.i128.md +++ b/docs/types/classes/_i128_.i128.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I128.ts#L14)* +*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I128.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i16_.i16.md b/docs/types/classes/_i16_.i16.md index 23637661aa..42b42ee7e9 100644 --- a/docs/types/classes/_i16_.i16.md +++ b/docs/types/classes/_i16_.i16.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I16.ts#L14)* +*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I16.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i256_.i256.md b/docs/types/classes/_i256_.i256.md index c71d16cf08..2f4139c3c2 100644 --- a/docs/types/classes/_i256_.i256.md +++ b/docs/types/classes/_i256_.i256.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I256.ts#L14)* +*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I256.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i32_.i32.md b/docs/types/classes/_i32_.i32.md index de5ac1edf5..f17e0b5ded 100644 --- a/docs/types/classes/_i32_.i32.md +++ b/docs/types/classes/_i32_.i32.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I32.ts#L14)* +*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I32.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i64_.i64.md b/docs/types/classes/_i64_.i64.md index 05e403e621..b5b6e2eb6e 100644 --- a/docs/types/classes/_i64_.i64.md +++ b/docs/types/classes/_i64_.i64.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I64.ts#L14)* +*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I64.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i8_.i8.md b/docs/types/classes/_i8_.i8.md index df7ddafb51..04aae23a4f 100644 --- a/docs/types/classes/_i8_.i8.md +++ b/docs/types/classes/_i8_.i8.md @@ -28,7 +28,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I8.ts#L14)* **Parameters:** @@ -54,7 +54,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -73,7 +73,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md index d9a5298168..17e5baa86a 100644 --- a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md +++ b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md @@ -27,7 +27,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -50,7 +50,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -85,7 +85,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -108,7 +108,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -132,7 +132,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -157,7 +157,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -174,7 +174,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -191,7 +191,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -210,7 +210,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_justification_.justification.html b/docs/types/classes/_justification_.justification.html index e9b78c7253..8e04b7d2cc 100644 --- a/docs/types/classes/_justification_.justification.html +++ b/docs/types/classes/_justification_.justification.html @@ -2152,7 +2152,7 @@

⊕ new Justification(value?: AnyU8a): Justification

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2176,7 +2176,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:61

+

Defined in Bytes.ts:61

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

Returns: number


@@ -2184,7 +2184,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2193,7 +2193,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2203,7 +2203,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2227,7 +2227,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2268,7 +2268,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2278,7 +2278,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2288,7 +2288,7 @@

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:69

+

Defined in Bytes.ts:69

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

Parameters:

@@ -2354,7 +2354,7 @@ diff --git a/docs/types/classes/_justification_.justification.md b/docs/types/classes/_justification_.justification.md index becc9cf3d6..c301b2e686 100644 --- a/docs/types/classes/_justification_.justification.md +++ b/docs/types/classes/_justification_.justification.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -85,7 +85,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -105,7 +105,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -128,7 +128,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -152,7 +152,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -169,7 +169,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -188,7 +188,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -207,7 +207,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_justification_.rhdjustification.html b/docs/types/classes/_justification_.rhdjustification.html index 49612563fe..78b558e106 100644 --- a/docs/types/classes/_justification_.rhdjustification.html +++ b/docs/types/classes/_justification_.rhdjustification.html @@ -2154,7 +2154,7 @@

constructor

⊕ new RhdJustification(value?: RhdJustificationValue | Uint8Array): RhdJustification

Overrides Struct.constructor

-

Defined in Justification.ts:33

+

Defined in Justification.ts:33

Parameters:

@@ -2178,7 +2178,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2186,28 +2186,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


hash

gethash(): Hash

-

Defined in Justification.ts:47

+

Defined in Justification.ts:47

description: The justification Hash

Returns: Hash


roundNumber

getroundNumber(): U32

-

Defined in Justification.ts:54

+

Defined in Justification.ts:54

description: The round this justification wraps as a U32

Returns: U32


signatures

getsignatures(): Vector<BftAuthoritySignature>

-

Defined in Justification.ts:61

+

Defined in Justification.ts:61

description: The BftAuthoritySignature array

Returns: Vector<BftAuthoritySignature>


@@ -2217,7 +2217,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2241,7 +2241,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2266,7 +2266,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2289,7 +2289,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2298,7 +2298,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2307,7 +2307,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2316,7 +2316,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2325,7 +2325,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2352,7 +2352,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2415,7 +2415,7 @@ diff --git a/docs/types/classes/_justification_.rhdjustification.md b/docs/types/classes/_justification_.rhdjustification.md index 98252310c7..0dc48b2b4a 100644 --- a/docs/types/classes/_justification_.rhdjustification.md +++ b/docs/types/classes/_justification_.rhdjustification.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Justification.ts#L33)* +*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Justification.ts#L33)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Justification.ts#L47)* +*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Justification.ts#L47)* *__description__*: The justification [Hash](_hash_.hash.md) @@ -92,7 +92,7 @@ ___ getroundNumber(): [U32](_u32_.u32.md) -*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Justification.ts#L54)* +*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Justification.ts#L54)* *__description__*: The round this justification wraps as a [U32](_u32_.u32.md) @@ -105,7 +105,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> -*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Justification.ts#L61)* +*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Justification.ts#L61)* *__description__*: The [BftAuthoritySignature](_bft_.bftauthoritysignature.md) array @@ -125,7 +125,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -148,7 +148,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -169,7 +169,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalue.html b/docs/types/classes/_keyvalue_.keyvalue.html index 96c562ea6c..72a968a8e8 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.html +++ b/docs/types/classes/_keyvalue_.keyvalue.html @@ -2154,7 +2154,7 @@

constructor

⊕ new KeyValue(value?: KeyValueValue | Uint8Array): KeyValue

Overrides Struct.constructor

-

Defined in KeyValue.ts:26

+

Defined in KeyValue.ts:26

Parameters:

@@ -2178,7 +2178,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2186,21 +2186,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:37

+

Defined in KeyValue.ts:37

description: The StorageKey

Returns: StorageKey


value

getvalue(): StorageData

-

Defined in KeyValue.ts:44

+

Defined in KeyValue.ts:44

description: The StorageData

Returns: StorageData


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2234,7 +2234,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2259,7 +2259,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2282,7 +2282,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2291,7 +2291,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2300,7 +2300,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2309,7 +2309,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2345,7 +2345,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2408,7 +2408,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md index 4329f7d78c..1b1b93cf69 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L26)* +*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L26)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L37)* +*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L37)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -92,7 +92,7 @@ ___ getvalue(): [StorageData](_storagedata_.storagedata.md) -*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L44)* +*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L44)* *__description__*: The [StorageData](_storagedata_.storagedata.md) @@ -112,7 +112,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -135,7 +135,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -156,7 +156,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -245,7 +245,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.html b/docs/types/classes/_keyvalue_.keyvalueoption.html index 8a3da87911..39fe4a5814 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.html +++ b/docs/types/classes/_keyvalue_.keyvalueoption.html @@ -2151,7 +2151,7 @@

constructor

⊕ new KeyValueOption(value?: KeyValueOptionValue | Uint8Array): KeyValueOption

Overrides Tuple.constructor

-

Defined in KeyValue.ts:58

+

Defined in KeyValue.ts:58

Parameters:

@@ -2175,7 +2175,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2183,21 +2183,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:69

+

Defined in KeyValue.ts:69

description: The StorageKey

Returns: StorageKey


value

getvalue(): Option<StorageData>

-

Defined in KeyValue.ts:76

+

Defined in KeyValue.ts:76

description: The Option StorageData

Returns: Option<StorageData>


@@ -2207,7 +2207,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2231,7 +2231,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2262,7 +2262,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2294,7 +2294,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2303,7 +2303,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2312,7 +2312,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2322,7 +2322,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2331,7 +2331,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2358,7 +2358,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md index b3a8e735d5..fb5788e296 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L58)* +*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L58)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L69)* +*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L69)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -90,7 +90,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> -*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L76)* +*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L76)* *__description__*: The [Option](_codec_option_.option.md) [StorageData](_storagedata_.storagedata.md) @@ -110,7 +110,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -133,7 +133,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -157,7 +157,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -182,7 +182,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -199,7 +199,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_lockperiods_.lockperiods.md b/docs/types/classes/_lockperiods_.lockperiods.md index e2d33e3400..21ec4587e5 100644 --- a/docs/types/classes/_lockperiods_.lockperiods.md +++ b/docs/types/classes/_lockperiods_.lockperiods.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/I8.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_index_.metadata.md b/docs/types/classes/_metadata_index_.metadata.md index 772ea60c2e..67ae1731a4 100644 --- a/docs/types/classes/_metadata_index_.metadata.md +++ b/docs/types/classes/_metadata_index_.metadata.md @@ -30,7 +30,7 @@ *Overrides [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[constructor](_metadata_metadataversioned_.metadataversioned.md#constructor)* -*Defined in [Metadata/index.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/index.ts#L15)* +*Defined in [Metadata/index.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/index.ts#L15)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -67,7 +67,7 @@ getasV0(): [MetadataV0](_metadata_v0_index_.metadatav0.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV0](_metadata_metadataversioned_.metadataversioned.md#asv0)* -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L86)* +*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L86)* *__description__*: Returns the wrapped metadata as a V0 object @@ -82,7 +82,7 @@ getasV1(): [MetadataV1](_metadata_v1_index_.metadatav1.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV1](_metadata_metadataversioned_.metadataversioned.md#asv1)* -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L103)* +*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L103)* *__description__*: Returns the wrapped values as a V1 object @@ -97,7 +97,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -112,7 +112,7 @@ getmagicNumber(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[magicNumber](_metadata_metadataversioned_.metadataversioned.md#magicnumber)* -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L65)* +*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L65)* *__description__*: @@ -127,7 +127,7 @@ getversion(): `number` *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[version](_metadata_metadataversioned_.metadataversioned.md#version)* -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L79)* +*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L79)* *__description__*: the metadata version this structure represents @@ -147,7 +147,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -170,7 +170,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -191,7 +191,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -214,7 +214,7 @@ ___ *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[getUniqTypes](_metadata_metadataversioned_.metadataversioned.md#getuniqtypes)* -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L109)* +*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L109)* **Returns:** `Array`<`string`> @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -244,7 +244,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -295,7 +295,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -316,7 +316,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_magicnumber_.magicnumber.md b/docs/types/classes/_metadata_magicnumber_.magicnumber.md index 1c3093a48c..489f5e3925 100644 --- a/docs/types/classes/_metadata_magicnumber_.magicnumber.md +++ b/docs/types/classes/_metadata_magicnumber_.magicnumber.md @@ -20,7 +20,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [Metadata/MagicNumber.ts:11](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MagicNumber.ts#L11)* +*Defined in [Metadata/MagicNumber.ts:11](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MagicNumber.ts#L11)* **Parameters:** @@ -46,7 +46,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -65,7 +65,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md index dcff0542e9..f20147df3d 100644 --- a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md +++ b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md @@ -32,7 +32,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/MetadataVersioned.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L53)* +*Defined in [Metadata/MetadataVersioned.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L53)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -67,7 +67,7 @@ ___ getasV0(): [MetadataV0](_metadata_v0_index_.metadatav0.md) -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L86)* +*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L86)* *__description__*: Returns the wrapped metadata as a V0 object @@ -80,7 +80,7 @@ ___ getasV1(): [MetadataV1](_metadata_v1_index_.metadatav1.md) -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L103)* +*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L103)* *__description__*: Returns the wrapped values as a V1 object @@ -95,7 +95,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -108,7 +108,7 @@ ___ getmagicNumber(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L65)* +*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L65)* *__description__*: @@ -121,7 +121,7 @@ ___ getversion(): `number` -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L79)* +*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L79)* *__description__*: the metadata version this structure represents @@ -141,7 +141,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -164,7 +164,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -185,7 +185,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -206,7 +206,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MetadataVersioned.ts#L109)* +*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MetadataVersioned.ts#L109)* **Returns:** `Array`<`string`> @@ -219,7 +219,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -270,7 +270,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -308,7 +308,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md index 9c13590539..50ce071f2e 100644 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Calls.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L10)* +*Defined in [Metadata/v0/Calls.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L10)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getindex(): [U16](_u16_.u16.md) -*Defined in [Metadata/v0/Calls.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L22)* +*Defined in [Metadata/v0/Calls.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L22)* *__description__*: The [U16](_u16_.u16.md) index for the call @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:29](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L29)* +*Defined in [Metadata/v0/Calls.ts:29](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L29)* *__description__*: The name for the call @@ -101,7 +101,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L36)* +*Defined in [Metadata/v0/Calls.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L36)* *__description__*: The call prefix (or section) @@ -121,7 +121,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -144,7 +144,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -165,7 +165,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -186,7 +186,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -275,7 +275,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md index 5aeef0f803..a1b8edf9b8 100644 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Calls.ts:41](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L41)* +*Defined in [Metadata/v0/Calls.ts:41](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L41)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> -*Defined in [Metadata/v0/Calls.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L52)* +*Defined in [Metadata/v0/Calls.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L52)* *__description__*: The \[\[OuterDispathCall\]\] wrapped @@ -75,7 +75,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Calls.ts#L59)* +*Defined in [Metadata/v0/Calls.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Calls.ts#L59)* *__description__*: The name for the dispatch @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.eventmetadata.md b/docs/types/classes/_metadata_v0_events_.eventmetadata.md index f36320604f..357fda8038 100644 --- a/docs/types/classes/_metadata_v0_events_.eventmetadata.md +++ b/docs/types/classes/_metadata_v0_events_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Events.ts:11](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L11)* +*Defined in [Metadata/v0/Events.ts:11](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L11)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata/v0/Events.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L23)* +*Defined in [Metadata/v0/Events.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L23)* *__description__*: The arguments of [Type](_metadata_v0_events_.eventmetadata.md#type) @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v0/Events.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L30)* +*Defined in [Metadata/v0/Events.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L30)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Events.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L37)* +*Defined in [Metadata/v0/Events.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L37)* *__description__*: The name for the event @@ -121,7 +121,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -144,7 +144,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -165,7 +165,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -186,7 +186,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -275,7 +275,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md b/docs/types/classes/_metadata_v0_events_.outereventmetadata.md index 19c46f209f..14d247fb9c 100644 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md +++ b/docs/types/classes/_metadata_v0_events_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Events.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L65)* +*Defined in [Metadata/v0/Events.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L65)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> -*Defined in [Metadata/v0/Events.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L76)* +*Defined in [Metadata/v0/Events.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L76)* *__description__*: The [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Events.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L83)* +*Defined in [Metadata/v0/Events.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L83)* *__description__*: The name of the event @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md index 718a63738f..fc58d62a40 100644 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md @@ -23,7 +23,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Metadata/v0/Events.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L42)* +*Defined in [Metadata/v0/Events.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L42)* **Parameters:** @@ -45,7 +45,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -60,7 +60,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -73,7 +73,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_v0_events_.eventmetadata.md)> -*Defined in [Metadata/v0/Events.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L53)* +*Defined in [Metadata/v0/Events.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L53)* *__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) @@ -86,7 +86,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Events.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Events.ts#L60)* +*Defined in [Metadata/v0/Events.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Events.ts#L60)* *__description__*: The name of the section @@ -106,7 +106,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -129,7 +129,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -153,7 +153,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -178,7 +178,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -195,7 +195,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -212,7 +212,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -269,7 +269,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_metadata_v0_index_.metadatav0.md b/docs/types/classes/_metadata_v0_index_.metadatav0.md index 8a86275fc8..03e30dc0e7 100644 --- a/docs/types/classes/_metadata_v0_index_.metadatav0.md +++ b/docs/types/classes/_metadata_v0_index_.metadatav0.md @@ -30,7 +30,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/index.ts:26](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L26)* +*Defined in [Metadata/v0/index.ts:26](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L26)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -65,7 +65,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> -*Defined in [Metadata/v0/index.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L60)* +*Defined in [Metadata/v0/index.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L60)* *__description__*: Wrapped [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) @@ -80,7 +80,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -93,7 +93,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> -*Defined in [Metadata/v0/index.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L67)* +*Defined in [Metadata/v0/index.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L67)* *__description__*: Wrapped [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) @@ -106,7 +106,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md)> -*Defined in [Metadata/v0/index.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L74)* +*Defined in [Metadata/v0/index.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L74)* *__description__*: Wrapped [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) @@ -126,7 +126,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -149,7 +149,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -170,7 +170,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -191,7 +191,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/v0/index.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L109)* +*Defined in [Metadata/v0/index.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L109)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -206,7 +206,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -293,7 +293,7 @@ ___ ▸ **decodeMetadata**(value: *`string` | `Uint8Array` | `object`*): `object` | `Uint8Array` -*Defined in [Metadata/v0/index.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/index.ts#L35)* +*Defined in [Metadata/v0/index.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/index.ts#L35)* **Parameters:** @@ -312,7 +312,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.callmetadata.md b/docs/types/classes/_metadata_v0_modules_.callmetadata.md index 02e3bc14ba..4fe9401629 100644 --- a/docs/types/classes/_metadata_v0_modules_.callmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L79)* +*Defined in [Metadata/v0/Modules.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L79)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:90](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L90)* +*Defined in [Metadata/v0/Modules.ts:90](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L90)* *__description__*: The functions available as [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L97)* +*Defined in [Metadata/v0/Modules.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L97)* *__description__*: The section name @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md index 419289ba4e..498f12e920 100644 --- a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L17)* +*Defined in [Metadata/v0/Modules.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L17)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L28)* +*Defined in [Metadata/v0/Modules.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L28)* *__description__*: The argument name @@ -88,7 +88,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L35)* +*Defined in [Metadata/v0/Modules.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L35)* *__description__*: The [Type](_metadata_v0_modules_.functionargumentmetadata.md#type) @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionmetadata.md index 3ff81d95c6..f12abed2d3 100644 --- a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L40)* +*Defined in [Metadata/v0/Modules.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L40)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L53)* +*Defined in [Metadata/v0/Modules.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L53)* *__description__*: The [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) for arguments @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v0/Modules.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L60)* +*Defined in [Metadata/v0/Modules.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L60)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getid(): [U16](_u16_.u16.md) -*Defined in [Metadata/v0/Modules.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L67)* +*Defined in [Metadata/v0/Modules.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L67)* *__description__*: The `[sectionIndex, methodIndex]` call id @@ -114,7 +114,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L74)* +*Defined in [Metadata/v0/Modules.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L74)* *__description__*: The call name @@ -134,7 +134,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -157,7 +157,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -178,7 +178,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -199,7 +199,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -288,7 +288,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.maptype.md b/docs/types/classes/_metadata_v0_modules_.maptype.md index e830beb05b..8de82ad958 100644 --- a/docs/types/classes/_metadata_v0_modules_.maptype.md +++ b/docs/types/classes/_metadata_v0_modules_.maptype.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:131](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L131)* +*Defined in [Metadata/v0/Modules.ts:131](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L131)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L142)* +*Defined in [Metadata/v0/Modules.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L142)* *__description__*: The mapped key as [Type](_metadata_v0_modules_.maptype.md#type) @@ -88,7 +88,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L149)* +*Defined in [Metadata/v0/Modules.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L149)* *__description__*: The mapped value as [Type](_metadata_v0_modules_.maptype.md#type) @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md b/docs/types/classes/_metadata_v0_modules_.modulemetadata.md index 3cc76fe182..a13154be76 100644 --- a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L102)* +*Defined in [Metadata/v0/Modules.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L102)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getcall(): [CallMetadata](_metadata_v0_modules_.callmetadata.md) -*Defined in [Metadata/v0/Modules.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L113)* +*Defined in [Metadata/v0/Modules.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L113)* *__description__*: The calls as [CallMetadata](_metadata_v0_modules_.callmetadata.md) @@ -75,7 +75,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:120](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L120)* +*Defined in [Metadata/v0/Modules.ts:120](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L120)* *__description__*: The name @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md index 2524940116..cefcd5309c 100644 --- a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:274](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L274)* +*Defined in [Metadata/v0/Modules.ts:274](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L274)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) -*Defined in [Metadata/v0/Modules.ts:286](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L286)* +*Defined in [Metadata/v0/Modules.ts:286](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L286)* *__description__*: The [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) @@ -88,7 +88,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:293](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L293)* +*Defined in [Metadata/v0/Modules.ts:293](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L293)* *__description__*: The prefix @@ -101,7 +101,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_v0_modules_.storagemetadata.md)> -*Defined in [Metadata/v0/Modules.ts:300](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L300)* +*Defined in [Metadata/v0/Modules.ts:300](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L300)* *__description__*: The optional [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) @@ -121,7 +121,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -144,7 +144,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -165,7 +165,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -186,7 +186,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -275,7 +275,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md index 2ec8c39f68..daa3fab603 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:204](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L204)* +*Defined in [Metadata/v0/Modules.ts:204](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L204)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getdefault(): [Bytes](_bytes_.bytes.md) -*Defined in [Metadata/v0/Modules.ts:218](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L218)* +*Defined in [Metadata/v0/Modules.ts:218](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L218)* *__description__*: The default value of the storage function @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v0/Modules.ts:225](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L225)* +*Defined in [Metadata/v0/Modules.ts:225](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L225)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) -*Defined in [Metadata/v0/Modules.ts:239](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L239)* +*Defined in [Metadata/v0/Modules.ts:239](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L239)* *__description__*: The modifier @@ -114,7 +114,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:232](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L232)* +*Defined in [Metadata/v0/Modules.ts:232](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L232)* *__description__*: The key name @@ -127,7 +127,7 @@ ___ gettype(): [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) -*Defined in [Metadata/v0/Modules.ts:246](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L246)* +*Defined in [Metadata/v0/Modules.ts:246](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L246)* *__description__*: The [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) @@ -147,7 +147,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -170,7 +170,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -191,7 +191,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -212,7 +212,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -263,7 +263,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -280,7 +280,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -301,7 +301,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md index 2a8ebb4e85..ce691c329f 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md @@ -20,7 +20,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:125](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L125)* +*Defined in [Metadata/v0/Modules.ts:125](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L125)* **Parameters:** @@ -42,7 +42,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L71)* *__description__*: Compares the value of the input to see if there is a match @@ -85,7 +85,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L84)* +*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -102,7 +102,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -117,7 +117,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L98)* *__description__*: Returns the number representation for the value @@ -134,7 +134,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the string representation of the value @@ -151,7 +151,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L113)* +*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L113)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -172,7 +172,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md index c28b5dd848..c9a04a32e3 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:157](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L157)* +*Defined in [Metadata/v0/Modules.ts:157](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L157)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [MapType](_metadata_v0_modules_.maptype.md) -*Defined in [Metadata/v0/Modules.ts:175](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L175)* +*Defined in [Metadata/v0/Modules.ts:175](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L175)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): `PlainType` -*Defined in [Metadata/v0/Modules.ts:182](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L182)* +*Defined in [Metadata/v0/Modules.ts:182](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L182)* *__description__*: The value as a \[\[Type\]\] value @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -97,7 +97,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/v0/Modules.ts:168](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L168)* +*Defined in [Metadata/v0/Modules.ts:168](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L168)* *__description__*: `true` if the storage entry is a map @@ -112,7 +112,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -127,7 +127,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -142,7 +142,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -157,7 +157,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -177,7 +177,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -200,7 +200,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -217,7 +217,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -232,7 +232,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -249,7 +249,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/v0/Modules.ts:189](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L189)* +*Defined in [Metadata/v0/Modules.ts:189](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L189)* *__description__*: Returns the string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -287,7 +287,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md b/docs/types/classes/_metadata_v0_modules_.storagemetadata.md index 1c843572ee..49e5b372f7 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:251](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L251)* +*Defined in [Metadata/v0/Modules.ts:251](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L251)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:262](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L262)* +*Defined in [Metadata/v0/Modules.ts:262](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L262)* *__description__*: The [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) for the section @@ -88,7 +88,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:269](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v0/Modules.ts#L269)* +*Defined in [Metadata/v0/Modules.ts:269](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v0/Modules.ts#L269)* *__description__*: The section prefix @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacall.md b/docs/types/classes/_metadata_v1_calls_.metadatacall.md index fdb78d6732..cefe839f91 100644 --- a/docs/types/classes/_metadata_v1_calls_.metadatacall.md +++ b/docs/types/classes/_metadata_v1_calls_.metadatacall.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Calls.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L38)* +*Defined in [Metadata/v1/Calls.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L38)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getargs(): [Vector](_codec_vector_.vector.md)<[MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md)> -*Defined in [Metadata/v1/Calls.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L53)* +*Defined in [Metadata/v1/Calls.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L53)* *__description__*: The [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) for arguments @@ -77,7 +77,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v1/Calls.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L60)* +*Defined in [Metadata/v1/Calls.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L60)* *__description__*: The [Text](_text_.text.md) documentation @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v1/Calls.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L74)* +*Defined in [Metadata/v1/Calls.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L74)* *__description__*: The call name @@ -125,7 +125,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -148,7 +148,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -169,7 +169,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md index 3f231f5151..c73982797d 100644 --- a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md +++ b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Calls.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L10)* +*Defined in [Metadata/v1/Calls.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L10)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v1/Calls.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L21)* +*Defined in [Metadata/v1/Calls.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L21)* *__description__*: The argument name @@ -88,7 +88,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata/v1/Calls.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Calls.ts#L28)* +*Defined in [Metadata/v1/Calls.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Calls.ts#L28)* *__description__*: The [Type](_metadata_v1_calls_.metadatacallarg.md#type) @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_events_.metadataevent.md b/docs/types/classes/_metadata_v1_events_.metadataevent.md index 0fa3ac62d2..bdcc7984e7 100644 --- a/docs/types/classes/_metadata_v1_events_.metadataevent.md +++ b/docs/types/classes/_metadata_v1_events_.metadataevent.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Events.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Events.ts#L15)* +*Defined in [Metadata/v1/Events.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Events.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getargs(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata/v1/Events.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Events.ts#L27)* +*Defined in [Metadata/v1/Events.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Events.ts#L27)* *__description__*: The [Type](_metadata_v1_events_.metadataevent.md#type) for args @@ -77,7 +77,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v1/Events.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Events.ts#L34)* +*Defined in [Metadata/v1/Events.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Events.ts#L34)* *__description__*: The [Text](_text_.text.md) documentation @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v1/Events.ts:41](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Events.ts#L41)* +*Defined in [Metadata/v1/Events.ts:41](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Events.ts#L41)* *__description__*: The call name @@ -125,7 +125,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -148,7 +148,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -169,7 +169,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_index_.metadatamodule.md b/docs/types/classes/_metadata_v1_index_.metadatamodule.md index 8b2a8698c6..7052ccb61e 100644 --- a/docs/types/classes/_metadata_v1_index_.metadatamodule.md +++ b/docs/types/classes/_metadata_v1_index_.metadatamodule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/index.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L22)* +*Defined in [Metadata/v1/index.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getcalls(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataCall](_metadata_v1_calls_.metadatacall.md)>> -*Defined in [Metadata/v1/index.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L36)* +*Defined in [Metadata/v1/index.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L36)* *__description__*: the module calls @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getevents(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataEvent](_metadata_v1_events_.metadataevent.md)>> -*Defined in [Metadata/v1/index.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L43)* +*Defined in [Metadata/v1/index.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L43)* *__description__*: the module events @@ -105,7 +105,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v1/index.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L50)* +*Defined in [Metadata/v1/index.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L50)* *__description__*: the module name @@ -118,7 +118,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/v1/index.ts:57](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L57)* +*Defined in [Metadata/v1/index.ts:57](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L57)* *__description__*: the module prefix @@ -131,7 +131,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataStorage](_metadata_v1_storage_.metadatastorage.md)>> -*Defined in [Metadata/v1/index.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L64)* +*Defined in [Metadata/v1/index.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L64)* *__description__*: the associated module storage @@ -151,7 +151,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -174,7 +174,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -195,7 +195,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -284,7 +284,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -305,7 +305,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_index_.metadatav1.md b/docs/types/classes/_metadata_v1_index_.metadatav1.md index 29f7362bef..61217c3e92 100644 --- a/docs/types/classes/_metadata_v1_index_.metadatav1.md +++ b/docs/types/classes/_metadata_v1_index_.metadatav1.md @@ -30,7 +30,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/index.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L74)* +*Defined in [Metadata/v1/index.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L74)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -80,7 +80,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[MetadataModule](_metadata_v1_index_.metadatamodule.md)> -*Defined in [Metadata/v1/index.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L84)* +*Defined in [Metadata/v1/index.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L84)* *__description__*: The associated modules for this structure @@ -100,7 +100,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -123,7 +123,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -144,7 +144,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -165,7 +165,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/v1/index.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/index.ts#L123)* +*Defined in [Metadata/v1/index.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/index.ts#L123)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -248,7 +248,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -269,7 +269,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.default.md b/docs/types/classes/_metadata_v1_storage_.default.md index f13cedf5fa..24780f4663 100644 --- a/docs/types/classes/_metadata_v1_storage_.default.md +++ b/docs/types/classes/_metadata_v1_storage_.default.md @@ -20,7 +20,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -40,7 +40,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -63,7 +63,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -80,7 +80,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -97,7 +97,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -114,7 +114,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_v1_storage_.maptype.md b/docs/types/classes/_metadata_v1_storage_.maptype.md index 0ad61ebd43..3a41da2a6e 100644 --- a/docs/types/classes/_metadata_v1_storage_.maptype.md +++ b/docs/types/classes/_metadata_v1_storage_.maptype.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L37)* +*Defined in [Metadata/v1/Storage.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L37)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata/v1/Storage.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L48)* +*Defined in [Metadata/v1/Storage.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L48)* *__description__*: The mapped key as [Type](_metadata_v1_storage_.maptype.md#type) @@ -88,7 +88,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata/v1/Storage.ts:55](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L55)* +*Defined in [Metadata/v1/Storage.ts:55](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L55)* *__description__*: The mapped value as [Type](_metadata_v1_storage_.maptype.md#type) @@ -108,7 +108,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md b/docs/types/classes/_metadata_v1_storage_.metadatastorage.md index 25958f4213..f674a9195f 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastorage.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L107)* +*Defined in [Metadata/v1/Storage.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L107)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/v1/Storage.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L121)* +*Defined in [Metadata/v1/Storage.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L121)* *__description__*: The [Text](_text_.text.md) documentation @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getfallback(): [Bytes](_bytes_.bytes.md) -*Defined in [Metadata/v1/Storage.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L128)* +*Defined in [Metadata/v1/Storage.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L128)* *__description__*: The [Bytes](_bytes_.bytes.md) fallback default @@ -105,7 +105,7 @@ ___ getmodifier(): [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) -*Defined in [Metadata/v1/Storage.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L135)* +*Defined in [Metadata/v1/Storage.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L135)* *__description__*: The \[\[MetadataArgument\]\] for arguments @@ -118,7 +118,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/v1/Storage.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L142)* +*Defined in [Metadata/v1/Storage.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L142)* *__description__*: The call name @@ -131,7 +131,7 @@ ___ gettype(): [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) -*Defined in [Metadata/v1/Storage.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L149)* +*Defined in [Metadata/v1/Storage.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L149)* *__description__*: The [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) @@ -151,7 +151,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -174,7 +174,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -195,7 +195,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -284,7 +284,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -305,7 +305,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md index f4e0a2b0b3..39b763fbd3 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L17)* +*Defined in [Metadata/v1/Storage.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L17)* **Parameters:** @@ -43,7 +43,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -73,7 +73,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -88,7 +88,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -101,7 +101,7 @@ ___ getisOptional(): `boolean` -*Defined in [Metadata/v1/Storage.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L28)* +*Defined in [Metadata/v1/Storage.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L28)* *__description__*: `true` if the storage entry is optional @@ -116,7 +116,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -131,7 +131,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -151,7 +151,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -174,7 +174,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -191,7 +191,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [Metadata/v1/Storage.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L32)* +*Defined in [Metadata/v1/Storage.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L32)* **Returns:** `any` @@ -204,7 +204,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -221,7 +221,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -238,7 +238,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -259,7 +259,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md index 1c2f491de1..492ddbc75f 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L63)* +*Defined in [Metadata/v1/Storage.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L63)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [MapType](_metadata_v1_storage_.maptype.md) -*Defined in [Metadata/v1/Storage.ts:81](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L81)* +*Defined in [Metadata/v1/Storage.ts:81](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L81)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): [PlainType](_metadata_v1_storage_.plaintype.md) -*Defined in [Metadata/v1/Storage.ts:88](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L88)* +*Defined in [Metadata/v1/Storage.ts:88](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L88)* *__description__*: The value as a \[\[Type\]\] value @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -97,7 +97,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/v1/Storage.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L74)* +*Defined in [Metadata/v1/Storage.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L74)* *__description__*: `true` if the storage entry is a map @@ -112,7 +112,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -127,7 +127,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -142,7 +142,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -157,7 +157,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -177,7 +177,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -200,7 +200,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -217,7 +217,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -232,7 +232,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -249,7 +249,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/v1/Storage.ts:95](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/Storage.ts#L95)* +*Defined in [Metadata/v1/Storage.ts:95](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/Storage.ts#L95)* *__description__*: Returns the string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -287,7 +287,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.optional.md b/docs/types/classes/_metadata_v1_storage_.optional.md index 3fdba3a71d..03ddf33389 100644 --- a/docs/types/classes/_metadata_v1_storage_.optional.md +++ b/docs/types/classes/_metadata_v1_storage_.optional.md @@ -20,7 +20,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -40,7 +40,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -63,7 +63,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -80,7 +80,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -97,7 +97,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -114,7 +114,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_v1_storage_.plaintype.md b/docs/types/classes/_metadata_v1_storage_.plaintype.md index 1322b37ee7..4df6f57a55 100644 --- a/docs/types/classes/_metadata_v1_storage_.plaintype.md +++ b/docs/types/classes/_metadata_v1_storage_.plaintype.md @@ -25,7 +25,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L19)* +*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [Text](_text_.text.md).[encodedLength](_text_.text.md#encodedlength)* -*Defined in [Type.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L76)* +*Defined in [Type.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L76)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L52)* +*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L52)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [Text](_text_.text.md).[eq](_text_.text.md#eq)* -*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L60)* +*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L60)* *__description__*: Compares the value of the input to see if there is a match @@ -109,7 +109,7 @@ ___ *Inherited from [Text](_text_.text.md).[toHex](_text_.text.md#tohex)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L69)* *__description__*: Returns a hex string representation of the value @@ -126,7 +126,7 @@ ___ *Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L76)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -145,7 +145,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L83)* +*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L83)* *__description__*: Returns the string representation of the value @@ -164,7 +164,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L87)* +*Defined in [Type.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L87)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_method_.method.html b/docs/types/classes/_method_.method.html index 6130accdfa..a88f4d7d07 100644 --- a/docs/types/classes/_method_.method.html +++ b/docs/types/classes/_method_.method.html @@ -2155,7 +2155,7 @@

constructor

⊕ new Method(value: any, meta?: FunctionMetadata): Method

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

@@ -2182,35 +2182,35 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Method.ts:192

+

Defined in Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>


argsDef

getargsDef(): ArgsDef

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: Thge argument defintions

Returns: ArgsDef


callIndex

getcallIndex(): Uint8Array

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: The encoded data

Returns: Uint8Array


@@ -2218,21 +2218,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


hasOrigin

gethasOrigin(): boolean

-

Defined in Method.ts:221

+

Defined in Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


meta

getmeta(): FunctionMetadata

-

Defined in Method.ts:230

+

Defined in Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata


@@ -2242,7 +2242,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2266,7 +2266,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2291,7 +2291,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2314,7 +2314,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2323,7 +2323,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2332,7 +2332,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2341,7 +2341,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2350,7 +2350,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2376,7 +2376,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

-

Defined in Method.ts:140

+

Defined in Method.ts:140

Parameters:

@@ -2397,7 +2397,7 @@

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

-

Defined in Method.ts:156

+

Defined in Method.ts:156

Parameters:

@@ -2418,7 +2418,7 @@

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

-

Defined in Method.ts:181

+

Defined in Method.ts:181

Parameters:

@@ -2440,7 +2440,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2503,7 +2503,7 @@ diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md index 41d1af4152..bee2a054f3 100644 --- a/docs/types/classes/_method_.method.md +++ b/docs/types/classes/_method_.method.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L70)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -67,7 +67,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L192)* +*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L192)* *__description__*: The arguments for the function call @@ -80,7 +80,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L200)* *__description__*: Thge argument defintions @@ -93,7 +93,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -106,7 +106,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L214)* *__description__*: The encoded data @@ -121,7 +121,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ ___ gethasOrigin(): `boolean` -*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L221)* +*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -147,7 +147,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) -*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L230)* +*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -190,7 +190,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -283,7 +283,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -300,7 +300,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -319,7 +319,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> -*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L140)* +*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L140)* **Parameters:** @@ -336,7 +336,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_method_.methodfunction.md) -*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L156)* +*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L156)* **Parameters:** @@ -353,7 +353,7 @@ ___ ▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_method_.moduleswithmethods.md)*): `void` -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L181)* **Parameters:** @@ -372,7 +372,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_method_.methodindex.html b/docs/types/classes/_method_.methodindex.html index ca323b9f00..3f428cbd8b 100644 --- a/docs/types/classes/_method_.methodindex.html +++ b/docs/types/classes/_method_.methodindex.html @@ -2151,7 +2151,7 @@

constructor

⊕ new MethodIndex(value?: AnyU8a): MethodIndex

Overrides U8aFixed.constructor

-

Defined in Method.ts:57

+

Defined in Method.ts:57

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2182,7 +2182,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2191,7 +2191,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2200,7 +2200,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2209,7 +2209,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2233,7 +2233,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2265,7 +2265,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2274,7 +2274,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2284,7 +2284,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2293,7 +2293,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2359,7 +2359,7 @@ diff --git a/docs/types/classes/_method_.methodindex.md b/docs/types/classes/_method_.methodindex.md index 19c8e15fc6..b1279d39d2 100644 --- a/docs/types/classes/_method_.methodindex.md +++ b/docs/types/classes/_method_.methodindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L57)* +*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L57)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -99,7 +99,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -116,7 +116,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -139,7 +139,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -163,7 +163,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -199,7 +199,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.html b/docs/types/classes/_misbehaviorreport_.bftatreport.html index 3fbf61e36f..1bb95385bd 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.html +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.html @@ -2157,7 +2157,7 @@

constructor

⊕ new BftAtReport(value?: BftAtReportValue | Uint8Array): BftAtReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2181,21 +2181,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


b

getb(): BftHashSignature

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2203,14 +2203,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2220,7 +2220,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2244,7 +2244,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2269,7 +2269,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2292,7 +2292,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2301,7 +2301,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2310,7 +2310,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2319,7 +2319,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2328,7 +2328,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2355,7 +2355,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2418,7 +2418,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md index 8e3c107b04..7b4fe55eaa 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -35,7 +35,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -57,7 +57,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -70,7 +70,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ ___ getb(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -111,7 +111,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -131,7 +131,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -154,7 +154,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -196,7 +196,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -213,7 +213,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -230,7 +230,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -247,7 +247,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -264,7 +264,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html index ec3a9c62bb..3bd3a17b11 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html @@ -2155,7 +2155,7 @@

⊕ new BftDoubleCommit(value?: BftAtReportValue | Uint8Array): BftDoubleCommit

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2179,7 +2179,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2187,7 +2187,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2195,7 +2195,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2203,7 +2203,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2211,7 +2211,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2221,7 +2221,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2245,7 +2245,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2270,7 +2270,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2293,7 +2293,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2302,7 +2302,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2311,7 +2311,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2320,7 +2320,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2329,7 +2329,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2356,7 +2356,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md index b7e25b48d7..24b5857dd5 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -156,7 +156,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -198,7 +198,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html index 4b5af2ce36..bd83dbe54f 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html @@ -2155,7 +2155,7 @@

⊕ new BftDoublePrepare(value?: BftAtReportValue | Uint8Array): BftDoublePrepare

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2179,7 +2179,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2187,7 +2187,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2195,7 +2195,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2203,7 +2203,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2211,7 +2211,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2221,7 +2221,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2245,7 +2245,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2270,7 +2270,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2293,7 +2293,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2302,7 +2302,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2311,7 +2311,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2320,7 +2320,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2329,7 +2329,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2356,7 +2356,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md index 71d73408b3..aecafb6fab 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -156,7 +156,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -198,7 +198,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html index fa2de39b31..35fe2587db 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html @@ -2155,7 +2155,7 @@

⊕ new BftDoublePropose(value?: BftAtReportValue | Uint8Array): BftDoublePropose

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2179,7 +2179,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2187,7 +2187,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2195,7 +2195,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2203,7 +2203,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2211,7 +2211,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2221,7 +2221,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2245,7 +2245,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2270,7 +2270,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2293,7 +2293,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2302,7 +2302,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2311,7 +2311,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2320,7 +2320,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2329,7 +2329,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2356,7 +2356,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md index a9f9a4834a..336eb76fc4 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -156,7 +156,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -198,7 +198,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html index 0609d71f1f..c263a04f2a 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html @@ -2154,7 +2154,7 @@

constructor

⊕ new BftProposeOutOfTurn(value?: BftAtReportValue | Uint8Array): BftProposeOutOfTurn

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:69

+

Defined in MisbehaviorReport.ts:69

Parameters:

@@ -2178,14 +2178,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:80

+

Defined in MisbehaviorReport.ts:80

description: The BftHashSignature the report applies to

Returns: BftHashSignature


@@ -2193,14 +2193,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:87

+

Defined in MisbehaviorReport.ts:87

description: The round as [[u32]]

Returns: U32


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2234,7 +2234,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2259,7 +2259,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2282,7 +2282,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2291,7 +2291,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2300,7 +2300,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2309,7 +2309,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2345,7 +2345,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2408,7 +2408,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md index 9afc8f1b43..aaba1a5f8b 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L69)* +*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L69)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L80)* +*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L80)* *__description__*: The [BftHashSignature](_bft_.bfthashsignature.md) the report applies to @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L87)* +*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L87)* *__description__*: The round as \[\[u32\]\] @@ -112,7 +112,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -135,7 +135,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -156,7 +156,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -245,7 +245,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html index 692e79b8d0..94596fd96a 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html @@ -2149,7 +2149,7 @@

constructor

⊕ new MisbehaviorKind(value?: BftAtReportValue | Uint8Array, index?: undefined | number): MisbehaviorKind

Overrides EnumType.constructor

-

Defined in MisbehaviorReport.ts:121

+

Defined in MisbehaviorReport.ts:121

Parameters:

@@ -2177,28 +2177,28 @@

asBftDoubleCommit

getasBftDoubleCommit(): BftDoubleCommit

-

Defined in MisbehaviorReport.ts:134

+

Defined in MisbehaviorReport.ts:134

description: Returns the item as a BftDoubleCommit

Returns: BftDoubleCommit


asBftDoublePrepare

getasBftDoublePrepare(): BftDoublePrepare

-

Defined in MisbehaviorReport.ts:141

+

Defined in MisbehaviorReport.ts:141

description: Returns the item as a BftDoublePrepare

Returns: BftDoublePrepare


asBftDoublePropose

getasBftDoublePropose(): BftDoublePropose

-

Defined in MisbehaviorReport.ts:148

+

Defined in MisbehaviorReport.ts:148

description: Returns the item as a BftDoublePropose

Returns: BftDoublePropose


asBftProposeOutOfTurn

getasBftProposeOutOfTurn(): BftProposeOutOfTurn

-

Defined in MisbehaviorReport.ts:155

+

Defined in MisbehaviorReport.ts:155

description: Returns the item as a BftProposeOutOfTurn

Returns: BftProposeOutOfTurn


@@ -2206,7 +2206,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


@@ -2214,7 +2214,7 @@

index

getindex(): number

Inherited from EnumType.index

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


@@ -2222,7 +2222,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2230,7 +2230,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

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

Returns: boolean


@@ -2238,7 +2238,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

description: The name of the type this enum value represents

Returns: string


@@ -2246,7 +2246,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The value of the enum

Returns: Codec


@@ -2256,7 +2256,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

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

Parameters:

@@ -2280,7 +2280,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:169

+

Defined in codec/EnumType.ts:169

description: Returns a hex string representation of the value

Returns: string


@@ -2289,7 +2289,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

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

Returns: any


@@ -2297,7 +2297,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:185

+

Defined in codec/EnumType.ts:185

description: Returns the number representation for the value

Returns: number


@@ -2306,7 +2306,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the string representation of the value

Returns: string


@@ -2315,7 +2315,7 @@

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

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:202

+

Defined in codec/EnumType.ts:202

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

Parameters:

@@ -2342,7 +2342,7 @@

<Static> with

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

Inherited from EnumType.with

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2405,7 +2405,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md index c4f4d7bef7..69a260f039 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L121)* +*Defined in [MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L121)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasBftDoubleCommit(): [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) -*Defined in [MisbehaviorReport.ts:134](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L134)* +*Defined in [MisbehaviorReport.ts:134](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L134)* *__description__*: Returns the item as a [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md) @@ -58,7 +58,7 @@ ___ getasBftDoublePrepare(): [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) -*Defined in [MisbehaviorReport.ts:141](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L141)* +*Defined in [MisbehaviorReport.ts:141](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L141)* *__description__*: Returns the item as a [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md) @@ -71,7 +71,7 @@ ___ getasBftDoublePropose(): [BftDoublePropose](_misbehaviorreport_.bftdoublepropose.md) -*Defined in [MisbehaviorReport.ts:148](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L148)* +*Defined in [MisbehaviorReport.ts:148](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L148)* *__description__*: Returns the item as a [BftDoublePropose](_misbehaviorreport_.bftdoublepropose.md) @@ -84,7 +84,7 @@ ___ getasBftProposeOutOfTurn(): [BftProposeOutOfTurn](_misbehaviorreport_.bftproposeoutofturn.md) -*Defined in [MisbehaviorReport.ts:155](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L155)* +*Defined in [MisbehaviorReport.ts:155](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L155)* *__description__*: Returns the item as a [BftProposeOutOfTurn](_misbehaviorreport_.bftproposeoutofturn.md) @@ -99,7 +99,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -114,7 +114,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -129,7 +129,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -144,7 +144,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -159,7 +159,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L142)* *__description__*: The name of the type this enum value represents @@ -174,7 +174,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The value of the enum @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L156)* *__description__*: Compares the value of the input to see if there is a match @@ -217,7 +217,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L169)* +*Defined in [codec/EnumType.ts:169](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L169)* *__description__*: Returns a hex string representation of the value @@ -234,7 +234,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -249,7 +249,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L185)* +*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L185)* *__description__*: Returns the number representation for the value @@ -266,7 +266,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the string representation of the value @@ -283,7 +283,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L202)* +*Defined in [codec/EnumType.ts:202](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L202)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -304,7 +304,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html index 50d9037de5..e2c5708cc0 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html @@ -2154,7 +2154,7 @@

constructor

⊕ new MisbehaviorReport(value?: MisbehaviorReportValue | Uint8Array): MisbehaviorReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:172

+

Defined in MisbehaviorReport.ts:172

Parameters:

@@ -2178,7 +2178,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2186,35 +2186,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


misbehavior

getmisbehavior(): MisbehaviorKind

-

Defined in MisbehaviorReport.ts:185

+

Defined in MisbehaviorReport.ts:185

description: The MisbehaviorKind

Returns: MisbehaviorKind


parentHash

getparentHash(): Hash

-

Defined in MisbehaviorReport.ts:192

+

Defined in MisbehaviorReport.ts:192

description: The Hash of the parent block

Returns: Hash


parentNumber

getparentNumber(): BlockNumber

-

Defined in MisbehaviorReport.ts:199

+

Defined in MisbehaviorReport.ts:199

description: The BlockNumber of the parent

Returns: BlockNumber


target

gettarget(): AuthorityId

-

Defined in MisbehaviorReport.ts:206

+

Defined in MisbehaviorReport.ts:206

description: The authorityId the report applies to

Returns: AuthorityId


@@ -2224,7 +2224,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2248,7 +2248,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2273,7 +2273,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2296,7 +2296,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2305,7 +2305,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2314,7 +2314,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2323,7 +2323,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2332,7 +2332,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2359,7 +2359,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2422,7 +2422,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md index 171f9bbb6b..7d1fd432a0 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:172](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L172)* +*Defined in [MisbehaviorReport.ts:172](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L172)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) -*Defined in [MisbehaviorReport.ts:185](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L185)* +*Defined in [MisbehaviorReport.ts:185](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L185)* *__description__*: The [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) @@ -92,7 +92,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [MisbehaviorReport.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L192)* +*Defined in [MisbehaviorReport.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L192)* *__description__*: The [Hash](_hash_.hash.md) of the parent block @@ -105,7 +105,7 @@ ___ getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [MisbehaviorReport.ts:199](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L199)* +*Defined in [MisbehaviorReport.ts:199](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L199)* *__description__*: The [BlockNumber](_blocknumber_.blocknumber.md) of the parent @@ -118,7 +118,7 @@ ___ gettarget(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [MisbehaviorReport.ts:206](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/MisbehaviorReport.ts#L206)* +*Defined in [MisbehaviorReport.ts:206](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/MisbehaviorReport.ts#L206)* *__description__*: The [authorityId](_bft_.bftauthoritysignature.md#authorityid) the report applies to @@ -138,7 +138,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -161,7 +161,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -182,7 +182,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -271,7 +271,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -292,7 +292,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_moment_.moment.html b/docs/types/classes/_moment_.moment.html index 7c87336509..19c7a6104b 100644 --- a/docs/types/classes/_moment_.moment.html +++ b/docs/types/classes/_moment_.moment.html @@ -2149,7 +2149,7 @@

constructor

⊕ new Moment(value?: Moment | Date | AnyNumber): Moment

-

Defined in Moment.ts:24

+

Defined in Moment.ts:24

Parameters:

@@ -2181,7 +2181,7 @@

encodedLength

getencodedLength(): number

-

Defined in Moment.ts:51

+

Defined in Moment.ts:51

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

Returns: number


@@ -2189,7 +2189,7 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in Moment.ts:65

+

Defined in Moment.ts:65

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -2197,7 +2197,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in Moment.ts:58

+

Defined in Moment.ts:58

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

Parameters:

@@ -2219,7 +2219,7 @@

toBn

▸ toBn(): BN

-

Defined in Moment.ts:72

+

Defined in Moment.ts:72

description: Returns the BN representation of the timestamp

Returns: BN


@@ -2227,7 +2227,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Moment.ts:79

+

Defined in Moment.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -2236,14 +2236,14 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Date.toJSON

-

Defined in Moment.ts:86

+

Defined in Moment.ts:86

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in Moment.ts:93

+

Defined in Moment.ts:93

description: Returns the number representation for the timestamp

Returns: number


@@ -2252,7 +2252,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Date.toString

-

Defined in Moment.ts:100

+

Defined in Moment.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2260,7 +2260,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in Moment.ts:109

+

Defined in Moment.ts:109

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

Parameters:

@@ -2286,7 +2286,7 @@

<Static> decodeMoment

▸ decodeMoment(value: Moment | Date | AnyNumber): Date

-

Defined in Moment.ts:34

+

Defined in Moment.ts:34

Parameters:

@@ -2349,7 +2349,7 @@ diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md index ee0ff8fb96..a2c1246222 100644 --- a/docs/types/classes/_moment_.moment.md +++ b/docs/types/classes/_moment_.moment.md @@ -24,7 +24,7 @@ ⊕ **new Moment**(value?: *[Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) -*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L24)* +*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L24)* **Parameters:** @@ -56,7 +56,7 @@ ___ getencodedLength(): `number` -*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L51)* +*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -72,7 +72,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L65)* +*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L65)* *__description__*: Returns the number of bits in the value @@ -87,7 +87,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L58)* +*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -106,7 +106,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L72)* +*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L72)* *__description__*: Returns the BN representation of the timestamp @@ -121,7 +121,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L79)* +*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -138,7 +138,7 @@ ___ *Overrides Date.toJSON* -*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L86)* +*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -151,7 +151,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L93)* +*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L93)* *__description__*: Returns the number representation for the timestamp @@ -168,7 +168,7 @@ ___ *Overrides Date.toString* -*Defined in [Moment.ts:100](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L100)* +*Defined in [Moment.ts:100](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L100)* *__description__*: Returns the string representation of the value @@ -183,7 +183,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [Moment.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L109)* +*Defined in [Moment.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -202,7 +202,7 @@ ___ ▸ **decodeMoment**(value: *[Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): `Date` -*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L34)* +*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_momentof_.momentof.md b/docs/types/classes/_momentof_.momentof.md index 410753ba0e..57c2dea200 100644 --- a/docs/types/classes/_momentof_.momentof.md +++ b/docs/types/classes/_momentof_.momentof.md @@ -24,7 +24,7 @@ *Inherited from [Moment](_moment_.moment.md).[constructor](_moment_.moment.md#constructor)* -*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L24)* +*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L24)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Moment](_moment_.moment.md).[encodedLength](_moment_.moment.md#encodedlength)* -*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L51)* +*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[bitLength](_moment_.moment.md#bitlength)* -*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L65)* +*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L65)* *__description__*: Returns the number of bits in the value @@ -81,7 +81,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[eq](_moment_.moment.md#eq)* -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L58)* +*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -102,7 +102,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[toBn](_moment_.moment.md#tobn)* -*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L72)* +*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L72)* *__description__*: Returns the BN representation of the timestamp @@ -119,7 +119,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[toHex](_moment_.moment.md#tohex)* -*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L79)* +*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -138,7 +138,7 @@ ___ *Overrides Date.toJSON* -*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L86)* +*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -153,7 +153,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[toNumber](_moment_.moment.md#tonumber)* -*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L93)* +*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L93)* *__description__*: Returns the number representation for the timestamp @@ -172,7 +172,7 @@ ___ *Overrides Date.toString* -*Defined in [Moment.ts:100](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L100)* +*Defined in [Moment.ts:100](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L100)* *__description__*: Returns the string representation of the value @@ -189,7 +189,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[toU8a](_moment_.moment.md#tou8a)* -*Defined in [Moment.ts:109](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L109)* +*Defined in [Moment.ts:109](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -210,7 +210,7 @@ ___ *Inherited from [Moment](_moment_.moment.md).[decodeMoment](_moment_.moment.md#decodemoment)* -*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Moment.ts#L34)* +*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html index 5352ad7f01..6111183f45 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html @@ -2149,7 +2149,7 @@

constructor

⊕ new NewAccountOutcome(index?: U8a | Uint8Array | number): NewAccountOutcome

Overrides Enum.constructor

-

Defined in NewAccountOutcome.ts:13

+

Defined in NewAccountOutcome.ts:13

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

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

Returns: number


@@ -2184,7 +2184,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Enum.eq

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

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

Parameters:

@@ -2208,7 +2208,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:84

+

Defined in codec/Enum.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2217,7 +2217,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:91

+

Defined in codec/Enum.ts:91

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

Returns: any


@@ -2225,7 +2225,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:98

+

Defined in codec/Enum.ts:98

description: Returns the number representation for the value

Returns: number


@@ -2234,7 +2234,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:105

+

Defined in codec/Enum.ts:105

description: Returns the string representation of the value

Returns: string


@@ -2243,7 +2243,7 @@

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

Implementation of Codec.toU8a

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:113

+

Defined in codec/Enum.ts:113

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

Parameters:

@@ -2270,7 +2270,7 @@

<Static> decodeEnum

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

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2338,7 +2338,7 @@ diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md index fa2fdc00c8..97cce1ac83 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/NewAccountOutcome.ts#L13)* +*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/NewAccountOutcome.ts#L13)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L71)* *__description__*: Compares the value of the input to see if there is a match @@ -89,7 +89,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L84)* +*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -106,7 +106,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -121,7 +121,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L98)* *__description__*: Returns the number representation for the value @@ -138,7 +138,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the string representation of the value @@ -155,7 +155,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L113)* +*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L113)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -176,7 +176,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_nonce_.nonce.html b/docs/types/classes/_nonce_.nonce.html index 4385bd1b71..c57e1fabeb 100644 --- a/docs/types/classes/_nonce_.nonce.html +++ b/docs/types/classes/_nonce_.nonce.html @@ -2150,7 +2150,7 @@

⊕ new Nonce(value?: AnyNumber): Nonce

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_nonce_.nonce.md b/docs/types/classes/_nonce_.nonce.md index df22df761e..98d7ad1d37 100644 --- a/docs/types/classes/_nonce_.nonce.md +++ b/docs/types/classes/_nonce_.nonce.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_noncecompact_.noncecompact.md b/docs/types/classes/_noncecompact_.noncecompact.md index 1ec7bd9f39..03d5d48a27 100644 --- a/docs/types/classes/_noncecompact_.noncecompact.md +++ b/docs/types/classes/_noncecompact_.noncecompact.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L23)* **Parameters:** @@ -49,7 +49,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)* -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. *__param__*: The Uint8Array to be prefixed @@ -63,7 +63,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)* -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L42)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)* -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L43)* ___ @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Compact](_codec_compact_.compact.md).[encodedLength](_codec_compact_.compact.md#encodedlength)* -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[bitLength](_codec_compact_.compact.md#bitlength)* -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L79)* *__description__*: Returns the number of bits in the value @@ -123,7 +123,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[eq](_codec_compact_.compact.md#eq)* -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L86)* *__description__*: Compares the value of the input to see if there is a match @@ -144,7 +144,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toBn](_codec_compact_.compact.md#tobn)* -*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L97)* +*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L97)* *__description__*: Returns the BN representation of the number @@ -161,7 +161,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toHex](_codec_compact_.compact.md#tohex)* -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L104)* +*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L104)* *__description__*: Returns a hex string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toJSON](_codec_compact_.compact.md#tojson)* -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L111)* +*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L111)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -193,7 +193,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toNumber](_codec_compact_.compact.md#tonumber)* -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L118)* +*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L118)* *__description__*: Returns the number representation for the value @@ -210,7 +210,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toString](_codec_compact_.compact.md#tostring)* -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L125)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L125)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toU8a](_codec_compact_.compact.md#tou8a)* -*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L133)* +*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L133)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[unwrap](_codec_compact_.compact.md#unwrap)* -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L140)* +*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L140)* *__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_moment_.moment.md) value @@ -263,7 +263,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[decodeCompact](_codec_compact_.compact.md#decodecompact)* -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -283,7 +283,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[stripLengthPrefix](_codec_compact_.compact.md#striplengthprefix)* -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -303,7 +303,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[with](_codec_compact_.compact.md#with)* -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Compact.ts#L28)* **Parameters:** diff --git a/docs/types/classes/_null_.null.html b/docs/types/classes/_null_.null.html index d5668c6b97..78a47ec57d 100644 --- a/docs/types/classes/_null_.null.html +++ b/docs/types/classes/_null_.null.html @@ -2155,7 +2155,7 @@

encodedLength

getencodedLength(): number

-

Defined in Null.ts:17

+

Defined in Null.ts:17

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

Returns: number


@@ -2164,7 +2164,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in Null.ts:24

+

Defined in Null.ts:24

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

Parameters:

@@ -2187,7 +2187,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Null.ts:31

+

Defined in Null.ts:31

description: Returns a hex string representation of the value

Returns: string


@@ -2195,7 +2195,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Null.ts:38

+

Defined in Null.ts:38

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

Returns: any


@@ -2203,7 +2203,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Returns the string representation of the value

Returns: string


@@ -2211,7 +2211,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in Null.ts:53

+

Defined in Null.ts:53

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

Parameters:

@@ -2277,7 +2277,7 @@ diff --git a/docs/types/classes/_null_.null.md b/docs/types/classes/_null_.null.md index 15843dc6d6..c9ad17a766 100644 --- a/docs/types/classes/_null_.null.md +++ b/docs/types/classes/_null_.null.md @@ -36,7 +36,7 @@ getencodedLength(): `number` -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -54,7 +54,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -75,7 +75,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -90,7 +90,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -105,7 +105,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -120,7 +120,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_origin_.origin.html b/docs/types/classes/_origin_.origin.html index 81ccce5d00..fd22da84a7 100644 --- a/docs/types/classes/_origin_.origin.html +++ b/docs/types/classes/_origin_.origin.html @@ -2148,7 +2148,7 @@

constructor

⊕ new Origin(): Origin

-

Defined in Origin.ts:13

+

Defined in Origin.ts:13

Returns: Origin


Accessors

@@ -2156,7 +2156,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:17

+

Defined in Null.ts:17

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

Returns: number


@@ -2166,7 +2166,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

-

Defined in Null.ts:24

+

Defined in Null.ts:24

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

Parameters:

@@ -2190,7 +2190,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:31

+

Defined in Null.ts:31

description: Returns a hex string representation of the value

Returns: string


@@ -2199,7 +2199,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:38

+

Defined in Null.ts:38

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

Returns: any


@@ -2208,7 +2208,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Returns the string representation of the value

Returns: string


@@ -2217,7 +2217,7 @@

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

Implementation of Codec.toU8a

Inherited from Null.toU8a

-

Defined in Null.ts:53

+

Defined in Null.ts:53

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

Parameters:

@@ -2283,7 +2283,7 @@ diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md index 477cff469e..6ce928e883 100644 --- a/docs/types/classes/_origin_.origin.md +++ b/docs/types/classes/_origin_.origin.md @@ -22,7 +22,7 @@ ⊕ **new Origin**(): [Origin](_origin_.origin.md) -*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Origin.ts#L13)* +*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Origin.ts#L13)* **Returns:** [Origin](_origin_.origin.md) @@ -38,7 +38,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L17)* +*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ *Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)* -*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L24)* +*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L24)* *__description__*: Compares the value of the input to see if there is a match @@ -81,7 +81,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L31)* +*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L31)* *__description__*: Returns a hex string representation of the value @@ -98,7 +98,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L38)* +*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L38)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -115,7 +115,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L45)* *__description__*: Returns the string representation of the value @@ -132,7 +132,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Null.ts#L53)* +*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Null.ts#L53)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_paraid_.paraid.md b/docs/types/classes/_paraid_.paraid.md index 82bf259f1b..f717bd2bd1 100644 --- a/docs/types/classes/_paraid_.paraid.md +++ b/docs/types/classes/_paraid_.paraid.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_peerinfo_.peerinfo.md b/docs/types/classes/_peerinfo_.peerinfo.md index bd12de9ce1..90ac8e321a 100644 --- a/docs/types/classes/_peerinfo_.peerinfo.md +++ b/docs/types/classes/_peerinfo_.peerinfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [PeerInfo.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L24)* +*Defined in [PeerInfo.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L24)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getbestHash(): [Hash](_hash_.hash.md) -*Defined in [PeerInfo.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L39)* +*Defined in [PeerInfo.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L39)* *__description__*: The best block hash for the peer @@ -77,7 +77,7 @@ ___ getbestNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [PeerInfo.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L46)* +*Defined in [PeerInfo.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L46)* *__description__*: The best block hash for the peer @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getindex(): [USize](_usize_.usize.md) -*Defined in [PeerInfo.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L53)* +*Defined in [PeerInfo.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L53)* *__description__*: The index of the peer in our list @@ -118,7 +118,7 @@ ___ getpeerId(): [Text](_text_.text.md) -*Defined in [PeerInfo.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L60)* +*Defined in [PeerInfo.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L60)* *__description__*: The p2p network id for the peer @@ -131,7 +131,7 @@ ___ getprotocolVersion(): [U32](_u32_.u32.md) -*Defined in [PeerInfo.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L67)* +*Defined in [PeerInfo.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L67)* *__description__*: The index of the peer in our list @@ -144,7 +144,7 @@ ___ getroles(): [Text](_text_.text.md) -*Defined in [PeerInfo.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/PeerInfo.ts#L74)* +*Defined in [PeerInfo.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/PeerInfo.ts#L74)* *__description__*: The roles of the peer on the network @@ -164,7 +164,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -187,7 +187,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -208,7 +208,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -263,7 +263,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -280,7 +280,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -318,7 +318,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html index 37c3fc4b1c..0ee88593d3 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html @@ -2153,7 +2153,7 @@

constructor

⊕ new PendingExtrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): PendingExtrinsics

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2186,14 +2186,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:56

+

Defined in codec/Vector.ts:56

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:63

+

Defined in codec/Vector.ts:63

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

Returns: number


@@ -2202,7 +2202,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:72

+

Defined in codec/Vector.ts:72

description: The length of the value

Returns: number


@@ -2212,7 +2212,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

-

Defined in codec/Vector.ts:80

+

Defined in codec/Vector.ts:80

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

Parameters:

@@ -2236,7 +2236,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:145

+

Defined in codec/Vector.ts:145

description: Filters the array with the callback

Parameters:

@@ -2267,7 +2267,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:154

+

Defined in codec/Vector.ts:154

description: Maps the array with the callback

Type parameters:

U

@@ -2299,7 +2299,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:87

+

Defined in codec/Vector.ts:87

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2308,7 +2308,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:94

+

Defined in codec/Vector.ts:94

description: Returns a hex string representation of the value

Returns: string


@@ -2317,7 +2317,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:101

+

Defined in codec/Vector.ts:101

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

Returns: any


@@ -2327,7 +2327,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:110

+

Defined in codec/Vector.ts:110

description: Returns the string representation of the value

Returns: string


@@ -2336,7 +2336,7 @@

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

Implementation of Codec.toU8a

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:123

+

Defined in codec/Vector.ts:123

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

Parameters:

@@ -2363,7 +2363,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2394,7 +2394,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2457,7 +2457,7 @@ diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md index 919368b009..c9156ea151 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L56)* +*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L56)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L63)* +*Defined in [codec/Vector.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L63)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L72)* +*Defined in [codec/Vector.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L72)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L80)* +*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L80)* *__description__*: Compares the value of the input to see if there is a match @@ -125,7 +125,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L145)* +*Defined in [codec/Vector.ts:145](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L145)* *__description__*: Filters the array with the callback @@ -149,7 +149,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L154)* +*Defined in [codec/Vector.ts:154](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L154)* *__description__*: Maps the array with the callback @@ -174,7 +174,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L87)* +*Defined in [codec/Vector.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L87)* *__description__*: Converts the Object to an standard JavaScript Array @@ -191,7 +191,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L94)* +*Defined in [codec/Vector.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L94)* *__description__*: Returns a hex string representation of the value @@ -208,7 +208,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L101)* +*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L101)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -227,7 +227,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L110)* +*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L110)* *__description__*: Returns the string representation of the value @@ -244,7 +244,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L123)* +*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -265,7 +265,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -288,7 +288,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_perbill_.perbill.html b/docs/types/classes/_perbill_.perbill.html index 279b09b14c..78c3fc411e 100644 --- a/docs/types/classes/_perbill_.perbill.html +++ b/docs/types/classes/_perbill_.perbill.html @@ -2150,7 +2150,7 @@

⊕ new Perbill(value?: AnyNumber): Perbill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md index 11fc1cb7c9..01789919ab 100644 --- a/docs/types/classes/_perbill_.perbill.md +++ b/docs/types/classes/_perbill_.perbill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_permill_.permill.html b/docs/types/classes/_permill_.permill.html index 58fe0bcda0..2d706c5442 100644 --- a/docs/types/classes/_permill_.permill.html +++ b/docs/types/classes/_permill_.permill.html @@ -2150,7 +2150,7 @@

⊕ new Permill(value?: AnyNumber): Permill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md index af09f7768a..e27d28822f 100644 --- a/docs/types/classes/_permill_.permill.md +++ b/docs/types/classes/_permill_.permill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_propindex_.propindex.html b/docs/types/classes/_propindex_.propindex.html index 6d06bb919e..d1e76ad1ec 100644 --- a/docs/types/classes/_propindex_.propindex.html +++ b/docs/types/classes/_propindex_.propindex.html @@ -2150,7 +2150,7 @@

⊕ new PropIndex(value?: AnyNumber): PropIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md index f0c27762b1..d81c3e1c7e 100644 --- a/docs/types/classes/_propindex_.propindex.md +++ b/docs/types/classes/_propindex_.propindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_proposal_.proposal.html b/docs/types/classes/_proposal_.proposal.html index b312b8f166..5239faf379 100644 --- a/docs/types/classes/_proposal_.proposal.html +++ b/docs/types/classes/_proposal_.proposal.html @@ -2155,7 +2155,7 @@

⊕ new Proposal(value: any, meta?: FunctionMetadata): Proposal

Inherited from Method.constructor

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

@@ -2182,7 +2182,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2190,7 +2190,7 @@

args

getargs(): Array<Codec>

Inherited from Method.args

-

Defined in Method.ts:192

+

Defined in Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>


@@ -2198,7 +2198,7 @@

argsDef

getargsDef(): ArgsDef

Inherited from Method.argsDef

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: Thge argument defintions

Returns: ArgsDef


@@ -2206,7 +2206,7 @@

callIndex

getcallIndex(): Uint8Array

Inherited from Method.callIndex

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


@@ -2214,7 +2214,7 @@

data

getdata(): Uint8Array

Inherited from Method.data

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: The encoded data

Returns: Uint8Array


@@ -2222,7 +2222,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2230,7 +2230,7 @@

hasOrigin

gethasOrigin(): boolean

Inherited from Method.hasOrigin

-

Defined in Method.ts:221

+

Defined in Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


@@ -2238,7 +2238,7 @@

meta

getmeta(): FunctionMetadata

Inherited from Method.meta

-

Defined in Method.ts:230

+

Defined in Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata


@@ -2248,7 +2248,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2272,7 +2272,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2297,7 +2297,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2320,7 +2320,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2329,7 +2329,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2338,7 +2338,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2347,7 +2347,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2356,7 +2356,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2383,7 +2383,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

Inherited from Method.filterOrigin

-

Defined in Method.ts:140

+

Defined in Method.ts:140

Parameters:

@@ -2405,7 +2405,7 @@

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

Inherited from Method.findFunction

-

Defined in Method.ts:156

+

Defined in Method.ts:156

Parameters:

@@ -2427,7 +2427,7 @@

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

Inherited from Method.injectMethods

-

Defined in Method.ts:181

+

Defined in Method.ts:181

Parameters:

@@ -2449,7 +2449,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2512,7 +2512,7 @@ diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md index 3463e5aa06..163e4aede2 100644 --- a/docs/types/classes/_proposal_.proposal.md +++ b/docs/types/classes/_proposal_.proposal.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L70)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -69,7 +69,7 @@ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> *Inherited from [Method](_method_.method.md).[args](_method_.method.md#args)* -*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L192)* +*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L192)* *__description__*: The arguments for the function call @@ -84,7 +84,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_method_.method.md).[argsDef](_method_.method.md#argsdef)* -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L200)* *__description__*: Thge argument defintions @@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_method_.method.md).[callIndex](_method_.method.md#callindex)* -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -114,7 +114,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_method_.method.md).[data](_method_.method.md#data)* -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L214)* *__description__*: The encoded data @@ -129,7 +129,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -144,7 +144,7 @@ gethasOrigin(): `boolean` *Inherited from [Method](_method_.method.md).[hasOrigin](_method_.method.md#hasorigin)* -*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L221)* +*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -159,7 +159,7 @@ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) *Inherited from [Method](_method_.method.md).[meta](_method_.method.md#meta)* -*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L230)* +*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -179,7 +179,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -202,7 +202,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -244,7 +244,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -295,7 +295,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -312,7 +312,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -333,7 +333,7 @@ ___ *Inherited from [Method](_method_.method.md).[filterOrigin](_method_.method.md#filterorigin)* -*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L140)* +*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L140)* **Parameters:** @@ -352,7 +352,7 @@ ___ *Inherited from [Method](_method_.method.md).[findFunction](_method_.method.md#findfunction)* -*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L156)* +*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L156)* **Parameters:** @@ -371,7 +371,7 @@ ___ *Inherited from [Method](_method_.method.md).[injectMethods](_method_.method.md#injectmethods)* -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L181)* **Parameters:** @@ -390,7 +390,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_proposalindex_.proposalindex.html b/docs/types/classes/_proposalindex_.proposalindex.html index 6f5717754d..2c9f0e021d 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.html +++ b/docs/types/classes/_proposalindex_.proposalindex.html @@ -2150,7 +2150,7 @@

⊕ new ProposalIndex(value?: AnyNumber): ProposalIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md index 15d1a3ad68..4f945ea409 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_referendumindex_.referendumindex.html b/docs/types/classes/_referendumindex_.referendumindex.html index f8c18bb615..a0996e7c86 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.html +++ b/docs/types/classes/_referendumindex_.referendumindex.html @@ -2150,7 +2150,7 @@

⊕ new ReferendumIndex(value?: AnyNumber): ReferendumIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md index f7321ad175..09c1ac9a9d 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_referenduminfo_.referenduminfo.md b/docs/types/classes/_referenduminfo_.referenduminfo.md index eca73b8696..8eeba82bdc 100644 --- a/docs/types/classes/_referenduminfo_.referenduminfo.md +++ b/docs/types/classes/_referenduminfo_.referenduminfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L22)* +*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L56)* +*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L56)* *__description__*: The delay (in blocks) to wait after a successful referendum before deploying @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getend(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L35)* +*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L35)* *__description__*: When voting on this referendum will end @@ -105,7 +105,7 @@ ___ getproposal(): [Proposal](_proposal_.proposal.md) -*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L42)* +*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L42)* *__description__*: The proposal being voted on @@ -118,7 +118,7 @@ ___ getthreshold(): [VoteThreshold](_votethreshold_.votethreshold.md) -*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ReferendumInfo.ts#L49)* +*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ReferendumInfo.ts#L49)* *__description__*: The thresholding mechanism to determine whether it passed @@ -138,7 +138,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -161,7 +161,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -182,7 +182,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -271,7 +271,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -292,7 +292,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.apiid.html b/docs/types/classes/_runtimeversion_.apiid.html index 23fa0b8b32..d6b711c50f 100644 --- a/docs/types/classes/_runtimeversion_.apiid.html +++ b/docs/types/classes/_runtimeversion_.apiid.html @@ -2151,7 +2151,7 @@

constructor

⊕ new ApiId(value?: AnyU8a): ApiId

Overrides U8aFixed.constructor

-

Defined in RuntimeVersion.ts:19

+

Defined in RuntimeVersion.ts:19

Parameters:

@@ -2174,7 +2174,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2182,7 +2182,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2191,7 +2191,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2200,7 +2200,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2209,7 +2209,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2233,7 +2233,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2265,7 +2265,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2274,7 +2274,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2284,7 +2284,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2293,7 +2293,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2359,7 +2359,7 @@ diff --git a/docs/types/classes/_runtimeversion_.apiid.md b/docs/types/classes/_runtimeversion_.apiid.md index 9cfe05f9a8..6939165109 100644 --- a/docs/types/classes/_runtimeversion_.apiid.md +++ b/docs/types/classes/_runtimeversion_.apiid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L19)* +*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -99,7 +99,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -116,7 +116,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -139,7 +139,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -163,7 +163,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -199,7 +199,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.html b/docs/types/classes/_runtimeversion_.runtimeversion.html index 724724851c..013a344799 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.html +++ b/docs/types/classes/_runtimeversion_.runtimeversion.html @@ -2154,7 +2154,7 @@

constructor

⊕ new RuntimeVersion(value?: RuntimeVersionValue | Uint8Array): RuntimeVersion

Overrides Struct.constructor

-

Defined in RuntimeVersion.ts:72

+

Defined in RuntimeVersion.ts:72

Parameters:

@@ -2178,21 +2178,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


apis

getapis(): Vector<RuntimeVersionApi>

-

Defined in RuntimeVersion.ts:93

+

Defined in RuntimeVersion.ts:93

description: The available APIs as RuntimeVersionApi

Returns: Vector<RuntimeVersionApi>


authoringVersion

getauthoringVersion(): U32

-

Defined in RuntimeVersion.ts:100

+

Defined in RuntimeVersion.ts:100

description: The authoring version as U32

Returns: U32


@@ -2200,35 +2200,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


implName

getimplName(): Text

-

Defined in RuntimeVersion.ts:107

+

Defined in RuntimeVersion.ts:107

description: The implementation name

Returns: Text


implVersion

getimplVersion(): U32

-

Defined in RuntimeVersion.ts:114

+

Defined in RuntimeVersion.ts:114

description: The implementation version

Returns: U32


specName

getspecName(): Text

-

Defined in RuntimeVersion.ts:121

+

Defined in RuntimeVersion.ts:121

description: The specification name

Returns: Text


specVersion

getspecVersion(): U32

-

Defined in RuntimeVersion.ts:128

+

Defined in RuntimeVersion.ts:128

description: The specification version

Returns: U32


@@ -2238,7 +2238,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2262,7 +2262,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2287,7 +2287,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2310,7 +2310,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2319,7 +2319,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2328,7 +2328,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2337,7 +2337,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2346,7 +2346,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2373,7 +2373,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2436,7 +2436,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md index c14c226ee1..818fc77b6f 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L72)* +*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L72)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md)> -*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L93)* +*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L93)* *__description__*: The available APIs as [RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md) @@ -77,7 +77,7 @@ ___ getauthoringVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L100)* +*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L100)* *__description__*: The authoring version as [U32](_u32_.u32.md) @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getimplName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L107)* +*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L107)* *__description__*: The implementation name @@ -118,7 +118,7 @@ ___ getimplVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L114)* +*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L114)* *__description__*: The implementation version @@ -131,7 +131,7 @@ ___ getspecName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L121)* +*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L121)* *__description__*: The specification name @@ -144,7 +144,7 @@ ___ getspecVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L128)* +*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L128)* *__description__*: The specification version @@ -164,7 +164,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -187,7 +187,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -208,7 +208,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -263,7 +263,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -280,7 +280,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -318,7 +318,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.html b/docs/types/classes/_runtimeversion_.runtimeversionapi.html index 7dc1fee238..6302278161 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.html +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.html @@ -2151,7 +2151,7 @@

constructor

⊕ new RuntimeVersionApi(value?: RuntimeVersionApiValue | Uint8Array): RuntimeVersionApi

Overrides Tuple.constructor

-

Defined in RuntimeVersion.ts:35

+

Defined in RuntimeVersion.ts:35

Parameters:

@@ -2175,7 +2175,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2183,21 +2183,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


id

getid(): ApiId

-

Defined in RuntimeVersion.ts:46

+

Defined in RuntimeVersion.ts:46

description: The ApiId

Returns: ApiId


version

getversion(): U32

-

Defined in RuntimeVersion.ts:53

+

Defined in RuntimeVersion.ts:53

description: The specific version as U32

Returns: U32


@@ -2207,7 +2207,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2231,7 +2231,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2262,7 +2262,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2294,7 +2294,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2303,7 +2303,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2312,7 +2312,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2322,7 +2322,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2331,7 +2331,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2358,7 +2358,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2419,7 +2419,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.md b/docs/types/classes/_runtimeversion_.runtimeversionapi.md index 056f754346..4e9e251983 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.md +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L35)* +*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L35)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getid(): [ApiId](_runtimeversion_.apiid.md) -*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L46)* +*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L46)* *__description__*: The [ApiId](_runtimeversion_.apiid.md) @@ -90,7 +90,7 @@ ___ getversion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/RuntimeVersion.ts#L53)* +*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/RuntimeVersion.ts#L53)* *__description__*: The specific version as [U32](_u32_.u32.md) @@ -110,7 +110,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -133,7 +133,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -157,7 +157,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -182,7 +182,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -199,7 +199,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_schedule_.schedule.md b/docs/types/classes/_schedule_.schedule.md index 8629a6affd..a2ead6c0a2 100644 --- a/docs/types/classes/_schedule_.schedule.md +++ b/docs/types/classes/_schedule_.schedule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Schedule.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L14)* +*Defined in [Schedule.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L14)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getgrowMemCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L32)* +*Defined in [Schedule.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L32)* *__description__*: Gas cost of a growing memory by single page. @@ -92,7 +92,7 @@ ___ getmaxMemoryPages(): [U32](_u32_.u32.md) -*Defined in [Schedule.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L39)* +*Defined in [Schedule.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L39)* *__description__*: What is the maximal memory pages amount is allowed to have for a contract. @@ -105,7 +105,7 @@ ___ getmaxStackHeight(): [U32](_u32_.u32.md) -*Defined in [Schedule.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L46)* +*Defined in [Schedule.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L46)* *__description__*: How tall the stack is allowed to grow? @@ -118,7 +118,7 @@ ___ getputCodePerByteCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L53)* +*Defined in [Schedule.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L53)* *__description__*: Cost of putting a byte of code into the storage. @@ -131,7 +131,7 @@ ___ getregularOpCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L60)* +*Defined in [Schedule.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L60)* *__description__*: Gas cost of a regular operation. @@ -144,7 +144,7 @@ ___ getreturnDataPerByteCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L67)* +*Defined in [Schedule.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L67)* *__description__*: Gas cost per one byte returned. @@ -157,7 +157,7 @@ ___ getsandboxDataReadCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:74](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L74)* +*Defined in [Schedule.ts:74](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L74)* *__description__*: Gas cost per one byte read from the sandbox memory. @@ -170,7 +170,7 @@ ___ getsandboxDataWriteCost(): [Gas](_gas_.gas.md) -*Defined in [Schedule.ts:81](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L81)* +*Defined in [Schedule.ts:81](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L81)* *__description__*: Gas cost per one byte written to the sandbox memory. @@ -183,7 +183,7 @@ ___ getversion(): [U32](_u32_.u32.md) -*Defined in [Schedule.ts:88](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Schedule.ts#L88)* +*Defined in [Schedule.ts:88](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Schedule.ts#L88)* *__description__*: Version of the schedule. @@ -203,7 +203,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -226,7 +226,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -247,7 +247,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -268,7 +268,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -302,7 +302,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -357,7 +357,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_seedof_.seedof.md b/docs/types/classes/_seedof_.seedof.md index 98a156c5cf..407179af40 100644 --- a/docs/types/classes/_seedof_.seedof.md +++ b/docs/types/classes/_seedof_.seedof.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -118,7 +118,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -141,7 +141,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -165,7 +165,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_sessionkey_.sessionkey.html b/docs/types/classes/_sessionkey_.sessionkey.html index aceb8e9fbe..f9ae750d7a 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.html +++ b/docs/types/classes/_sessionkey_.sessionkey.html @@ -2152,7 +2152,7 @@

⊕ new SessionKey(value?: AnyU8a): SessionKey

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2177,7 +2177,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2185,7 +2185,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2194,7 +2194,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2203,7 +2203,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2213,7 +2213,7 @@

Implementation of Codec.eq

Inherited from AccountId.eq

Overrides U8a.eq

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Parameters:

@@ -2237,7 +2237,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2269,7 +2269,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2279,7 +2279,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

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

Returns: any


@@ -2289,7 +2289,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:60

+

Defined in AccountId.ts:60

description: Returns the string representation of the value

Returns: string


@@ -2298,7 +2298,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2325,7 +2325,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2386,7 +2386,7 @@ diff --git a/docs/types/classes/_sessionkey_.sessionkey.md b/docs/types/classes/_sessionkey_.sessionkey.md index 8dc7aa7fc2..9dd033a3e6 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.md +++ b/docs/types/classes/_sessionkey_.sessionkey.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -101,7 +101,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -120,7 +120,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -143,7 +143,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -167,7 +167,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -186,7 +186,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L60)* +*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -222,7 +222,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -243,7 +243,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_signature_.signature.html b/docs/types/classes/_signature_.signature.html index 9a545d502d..c076f32ecd 100644 --- a/docs/types/classes/_signature_.signature.html +++ b/docs/types/classes/_signature_.signature.html @@ -2153,7 +2153,7 @@

⊕ new Signature(value?: AnyU8a): Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

@@ -2176,7 +2176,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2184,7 +2184,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2193,7 +2193,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2202,7 +2202,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2211,7 +2211,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2235,7 +2235,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2267,7 +2267,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2276,7 +2276,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2286,7 +2286,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2295,7 +2295,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2361,7 +2361,7 @@ diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md index 83ca6882fd..6cb3b505be 100644 --- a/docs/types/classes/_signature_.signature.md +++ b/docs/types/classes/_signature_.signature.md @@ -31,7 +31,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/H512.ts#L14)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -85,7 +85,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -103,7 +103,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -120,7 +120,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -143,7 +143,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -167,7 +167,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -203,7 +203,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.html b/docs/types/classes/_signaturepayload_.signaturepayload.html index f922edf7f6..9ab21fe44e 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.html +++ b/docs/types/classes/_signaturepayload_.signaturepayload.html @@ -2155,7 +2155,7 @@

constructor

⊕ new SignaturePayload(value?: SignaturePayloadValue | Uint8Array): SignaturePayload

Overrides Struct.constructor

-

Defined in SignaturePayload.ts:36

+

Defined in SignaturePayload.ts:36

Parameters:

@@ -2179,14 +2179,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockHash

getblockHash(): Hash

-

Defined in SignaturePayload.ts:57

+

Defined in SignaturePayload.ts:57

description: The block Hash the signature applies to (mortal/immortal)

Returns: Hash


@@ -2194,42 +2194,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


era

getera(): ExtrinsicEra

-

Defined in SignaturePayload.ts:71

+

Defined in SignaturePayload.ts:71

description: The ExtrinsicEra

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in SignaturePayload.ts:50

+

Defined in SignaturePayload.ts:50

description: true if the payload refers to a valid signature

Returns: boolean


method

getmethod(): Method

-

Defined in SignaturePayload.ts:64

+

Defined in SignaturePayload.ts:64

description: The Method contained in the payload

Returns: Method


nonce

getnonce(): Nonce

-

Defined in SignaturePayload.ts:78

+

Defined in SignaturePayload.ts:78

description: The Nonce

Returns: Nonce


signature

getsignature(): Uint8Array

-

Defined in SignaturePayload.ts:85

+

Defined in SignaturePayload.ts:85

description: The raw signature as a Uint8Array

Returns: Uint8Array


@@ -2239,7 +2239,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2263,7 +2263,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2288,7 +2288,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2310,7 +2310,7 @@

sign

▸ sign(signerPair: KeyringPair, version?: RuntimeVersion): Uint8Array

-

Defined in SignaturePayload.ts:96

+

Defined in SignaturePayload.ts:96

description: Sign the payload with the keypair

Parameters:

@@ -2337,7 +2337,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2346,7 +2346,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2355,7 +2355,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2364,7 +2364,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2373,7 +2373,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2400,7 +2400,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2463,7 +2463,7 @@ diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md index 9331cc74da..5aa2df66f6 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_signaturepayload_.signaturepayload.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignaturePayload.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L36)* +*Defined in [SignaturePayload.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L36)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ ___ getblockHash(): [Hash](_hash_.hash.md) -*Defined in [SignaturePayload.ts:57](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L57)* +*Defined in [SignaturePayload.ts:57](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L57)* *__description__*: The block [Hash](_hash_.hash.md) the signature applies to (mortal/immortal) @@ -81,7 +81,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -94,7 +94,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [SignaturePayload.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L71)* +*Defined in [SignaturePayload.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L71)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -107,7 +107,7 @@ ___ getisSigned(): `boolean` -*Defined in [SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L50)* +*Defined in [SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L50)* *__description__*: `true` if the payload refers to a valid signature @@ -120,7 +120,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [SignaturePayload.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L64)* +*Defined in [SignaturePayload.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L64)* *__description__*: The [Method](_method_.method.md) contained in the payload @@ -133,7 +133,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [SignaturePayload.ts:78](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L78)* +*Defined in [SignaturePayload.ts:78](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L78)* *__description__*: The [Nonce](_nonce_.nonce.md) @@ -146,7 +146,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [SignaturePayload.ts:85](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L85)* +*Defined in [SignaturePayload.ts:85](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L85)* *__description__*: The raw signature as a `Uint8Array` @@ -166,7 +166,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -189,7 +189,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -229,7 +229,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, version?: *[RuntimeVersion](_runtimeversion_.runtimeversion.md)*): `Uint8Array` -*Defined in [SignaturePayload.ts:96](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignaturePayload.ts#L96)* +*Defined in [SignaturePayload.ts:96](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignaturePayload.ts#L96)* *__description__*: Sign the payload with the keypair @@ -251,7 +251,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -268,7 +268,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -302,7 +302,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_signedblock_.signedblock.html b/docs/types/classes/_signedblock_.signedblock.html index eb296c0345..cf6435cf40 100644 --- a/docs/types/classes/_signedblock_.signedblock.html +++ b/docs/types/classes/_signedblock_.signedblock.html @@ -2154,7 +2154,7 @@

constructor

⊕ new SignedBlock(value?: SignedBlockValue | Uint8Array): SignedBlock

Overrides Struct.constructor

-

Defined in SignedBlock.ts:22

+

Defined in SignedBlock.ts:22

Parameters:

@@ -2178,14 +2178,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Block

-

Defined in SignedBlock.ts:33

+

Defined in SignedBlock.ts:33

description: The wrapped Block

Returns: Block


@@ -2193,21 +2193,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


hash

gethash(): Hash

-

Defined in SignedBlock.ts:40

+

Defined in SignedBlock.ts:40

description: Block/header Hash

Returns: Hash


justification

getjustification(): Justification

-

Defined in SignedBlock.ts:47

+

Defined in SignedBlock.ts:47

description: The wrapped Justification

Returns: Justification


@@ -2217,7 +2217,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2241,7 +2241,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2266,7 +2266,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2289,7 +2289,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2298,7 +2298,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2307,7 +2307,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2316,7 +2316,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2325,7 +2325,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2352,7 +2352,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2415,7 +2415,7 @@ diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md index a59bd3ae0d..62be66c519 100644 --- a/docs/types/classes/_signedblock_.signedblock.md +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignedBlock.ts#L22)* +*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignedBlock.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getblock(): [Block](_block_.block.md) -*Defined in [SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignedBlock.ts#L33)* +*Defined in [SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignedBlock.ts#L33)* *__description__*: The wrapped [Block](_block_.block.md) @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignedBlock.ts#L40)* +*Defined in [SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignedBlock.ts#L40)* *__description__*: Block/header [Hash](_hash_.hash.md) @@ -105,7 +105,7 @@ ___ getjustification(): [Justification](_justification_.justification.md) -*Defined in [SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/SignedBlock.ts#L47)* +*Defined in [SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/SignedBlock.ts#L47)* *__description__*: The wrapped [Justification](_justification_.justification.md) @@ -125,7 +125,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -148,7 +148,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -169,7 +169,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.html b/docs/types/classes/_storagechangeset_.storagechangeset.html index 7e7617e55d..28521f5955 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.html +++ b/docs/types/classes/_storagechangeset_.storagechangeset.html @@ -2154,7 +2154,7 @@

constructor

⊕ new StorageChangeSet(value?: StorageChangeSetValue | Uint8Array): StorageChangeSet

Overrides Struct.constructor

-

Defined in StorageChangeSet.ts:24

+

Defined in StorageChangeSet.ts:24

Parameters:

@@ -2178,21 +2178,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Hash

-

Defined in StorageChangeSet.ts:42

+

Defined in StorageChangeSet.ts:42

description: The block Hash

Returns: Hash


changes

getchanges(): Vector<KeyValueOption>

-

Defined in StorageChangeSet.ts:35

+

Defined in StorageChangeSet.ts:35

description: The applicable changes as KeyValueOption

Returns: Vector<KeyValueOption>


@@ -2200,7 +2200,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2234,7 +2234,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2259,7 +2259,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2282,7 +2282,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2291,7 +2291,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2300,7 +2300,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2309,7 +2309,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2345,7 +2345,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2408,7 +2408,7 @@ diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md index f973d888b5..24d89537fe 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageChangeSet.ts#L24)* +*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageChangeSet.ts#L24)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getblock(): [Hash](_hash_.hash.md) -*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageChangeSet.ts#L42)* +*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageChangeSet.ts#L42)* *__description__*: The block [Hash](_hash_.hash.md) @@ -77,7 +77,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> -*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageChangeSet.ts#L35)* +*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageChangeSet.ts#L35)* *__description__*: The applicable changes as [KeyValueOption](_keyvalue_.keyvalueoption.md) @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -112,7 +112,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -135,7 +135,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -156,7 +156,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -245,7 +245,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagedata_.storagedata.html b/docs/types/classes/_storagedata_.storagedata.html index 893f39797d..3ce33e3b95 100644 --- a/docs/types/classes/_storagedata_.storagedata.html +++ b/docs/types/classes/_storagedata_.storagedata.html @@ -2152,7 +2152,7 @@

⊕ new StorageData(value?: AnyU8a): StorageData

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2176,7 +2176,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:61

+

Defined in Bytes.ts:61

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

Returns: number


@@ -2184,7 +2184,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2193,7 +2193,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2203,7 +2203,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2227,7 +2227,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2268,7 +2268,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2278,7 +2278,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2288,7 +2288,7 @@

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:69

+

Defined in Bytes.ts:69

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

Parameters:

@@ -2354,7 +2354,7 @@ diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md index 954a72d3b8..11414f561c 100644 --- a/docs/types/classes/_storagedata_.storagedata.md +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -85,7 +85,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -105,7 +105,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -128,7 +128,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -152,7 +152,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -169,7 +169,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -188,7 +188,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -207,7 +207,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_storagekey_.storagekey.html b/docs/types/classes/_storagekey_.storagekey.html index 7bf044135b..227ca23b61 100644 --- a/docs/types/classes/_storagekey_.storagekey.html +++ b/docs/types/classes/_storagekey_.storagekey.html @@ -2151,7 +2151,7 @@

constructor

⊕ new StorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): StorageKey

Overrides Bytes.constructor

-

Defined in StorageKey.ts:28

+

Defined in StorageKey.ts:28

Parameters:

@@ -2178,7 +2178,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:61

+

Defined in Bytes.ts:61

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

Returns: number


@@ -2186,7 +2186,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2195,21 +2195,21 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


meta

getmeta(): StorageFunctionMetadata | null

-

Defined in StorageKey.ts:82

+

Defined in StorageKey.ts:82

description: The metadata or null when not available

Returns: StorageFunctionMetadata | null


outputType

getoutputType(): string | null

-

Defined in StorageKey.ts:89

+

Defined in StorageKey.ts:89

description: The output type, null when not available

Returns: string | null


@@ -2219,7 +2219,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

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

Parameters:

@@ -2243,7 +2243,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2275,7 +2275,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2284,7 +2284,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2294,7 +2294,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2304,7 +2304,7 @@

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:69

+

Defined in Bytes.ts:69

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

Parameters:

@@ -2330,7 +2330,7 @@

<Static> decodeStorageKey

▸ decodeStorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): Uint8Array

-

Defined in StorageKey.ts:37

+

Defined in StorageKey.ts:37

Parameters:

@@ -2354,7 +2354,7 @@

<Static> getMeta

▸ getMeta(value: StorageKey | StorageFunction | [StorageFunction, any]): StorageFunctionMetadata | null

-

Defined in StorageKey.ts:51

+

Defined in StorageKey.ts:51

Parameters:

@@ -2377,7 +2377,7 @@

<Static> getType

▸ getType(value: StorageKey | StorageFunction | [StorageFunction, any]): string | null

-

Defined in StorageKey.ts:65

+

Defined in StorageKey.ts:65

Parameters:

@@ -2440,7 +2440,7 @@ diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md index 118a3d75fd..c9a58954a1 100644 --- a/docs/types/classes/_storagekey_.storagekey.md +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -27,7 +27,7 @@ *Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* -*Defined in [StorageKey.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L28)* +*Defined in [StorageKey.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L28)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L61)* +*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -96,7 +96,7 @@ ___ getmeta(): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) | `null` -*Defined in [StorageKey.ts:82](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L82)* +*Defined in [StorageKey.ts:82](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L82)* *__description__*: The metadata or `null` when not available @@ -109,7 +109,7 @@ ___ getoutputType(): `string` | `null` -*Defined in [StorageKey.ts:89](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L89)* +*Defined in [StorageKey.ts:89](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L89)* *__description__*: The output type, `null` when not available @@ -129,7 +129,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -152,7 +152,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -176,7 +176,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -231,7 +231,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bytes.ts#L69)* +*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -250,7 +250,7 @@ ___ ▸ **decodeStorageKey**(value: *[AnyU8a](../modules/_types_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [StorageKey.ts:37](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L37)* +*Defined in [StorageKey.ts:37](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L37)* **Parameters:** @@ -267,7 +267,7 @@ ___ ▸ **getMeta**(value: *[StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) | `null` -*Defined in [StorageKey.ts:51](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L51)* +*Defined in [StorageKey.ts:51](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L51)* **Parameters:** @@ -284,7 +284,7 @@ ___ ▸ **getType**(value: *[StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` -*Defined in [StorageKey.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L65)* +*Defined in [StorageKey.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L65)* **Parameters:** diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.html b/docs/types/classes/_storedpendingchange_.nextauthority.html index 3a0c8a7bf0..479c82e23f 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.html +++ b/docs/types/classes/_storedpendingchange_.nextauthority.html @@ -2151,7 +2151,7 @@

constructor

⊕ new NextAuthority(value?: Uint8Array | NextAuthorityValue): NextAuthority

Overrides Tuple.constructor

-

Defined in StoredPendingChange.ts:31

+

Defined in StoredPendingChange.ts:31

Parameters:

@@ -2175,7 +2175,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2183,20 +2183,20 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

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

Returns: number


index

getindex(): U64

-

Defined in StoredPendingChange.ts:39

+

Defined in StoredPendingChange.ts:39

Returns: U64


sessionKey

getsessionKey(): SessionKey

-

Defined in StoredPendingChange.ts:43

+

Defined in StoredPendingChange.ts:43

Returns: SessionKey


Methods

@@ -2205,7 +2205,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

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

Parameters:

@@ -2229,7 +2229,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:133

+

Defined in codec/Tuple.ts:133

description: Filters the array with the callback

Parameters:

@@ -2260,7 +2260,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:142

+

Defined in codec/Tuple.ts:142

description: Maps the array with the callback

Type parameters:

U

@@ -2292,7 +2292,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2301,7 +2301,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2310,7 +2310,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

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

Returns: any


@@ -2320,7 +2320,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:107

+

Defined in codec/Tuple.ts:107

description: Returns the string representation of the value

Returns: string


@@ -2329,7 +2329,7 @@

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

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:116

+

Defined in codec/Tuple.ts:116

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

Parameters:

@@ -2356,7 +2356,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2417,7 +2417,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.md b/docs/types/classes/_storedpendingchange_.nextauthority.md index 6dc6ddecb1..4361a877cf 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.md +++ b/docs/types/classes/_storedpendingchange_.nextauthority.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L31)* +*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L31)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getindex(): [U64](_u64_.u64.md) -*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L39)* +*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L39)* **Returns:** [U64](_u64_.u64.md) @@ -88,7 +88,7 @@ ___ getsessionKey(): [SessionKey](_sessionkey_.sessionkey.md) -*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L43)* +*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L43)* **Returns:** [SessionKey](_sessionkey_.sessionkey.md) @@ -106,7 +106,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Compares the value of the input to see if there is a match @@ -129,7 +129,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L133)* +*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L133)* *__description__*: Filters the array with the callback @@ -153,7 +153,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L142)* +*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L142)* *__description__*: Maps the array with the callback @@ -178,7 +178,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Converts the Object to an standard JavaScript Array @@ -195,7 +195,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -212,7 +212,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L107)* +*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L107)* *__description__*: Returns the string representation of the value @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L116)* +*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -269,7 +269,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.html b/docs/types/classes/_storedpendingchange_.storedpendingchange.html index 4d3b377af3..a3f1149219 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.html +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.html @@ -2154,7 +2154,7 @@

constructor

⊕ new StoredPendingChange(value?: Uint8Array | StoredPendingChangeValue): StoredPendingChange

Overrides Struct.constructor

-

Defined in StoredPendingChange.ts:53

+

Defined in StoredPendingChange.ts:53

Parameters:

@@ -2178,34 +2178,34 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


delay

getdelay(): BlockNumber

-

Defined in StoredPendingChange.ts:65

+

Defined in StoredPendingChange.ts:65

Returns: BlockNumber


encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


nextAuthorities

getnextAuthorities(): Vector<NextAuthority>

-

Defined in StoredPendingChange.ts:69

+

Defined in StoredPendingChange.ts:69

Returns: Vector<NextAuthority>


scheduledAt

getscheduledAt(): BlockNumber

-

Defined in StoredPendingChange.ts:73

+

Defined in StoredPendingChange.ts:73

Returns: BlockNumber


Methods

@@ -2214,7 +2214,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2238,7 +2238,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2263,7 +2263,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2286,7 +2286,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2295,7 +2295,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2304,7 +2304,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2313,7 +2313,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2322,7 +2322,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2349,7 +2349,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2412,7 +2412,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.md b/docs/types/classes/_storedpendingchange_.storedpendingchange.md index 13e19fd029..6a8a9f47f3 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.md +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L53)* +*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L53)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L65)* +*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L65)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -77,7 +77,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -90,7 +90,7 @@ ___ getnextAuthorities(): [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> -*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L69)* +*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L69)* **Returns:** [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> @@ -101,7 +101,7 @@ ___ getscheduledAt(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L73)* +*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L73)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -119,7 +119,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -142,7 +142,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -163,7 +163,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -252,7 +252,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -273,7 +273,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_text_.text.html b/docs/types/classes/_text_.text.html index 1ba4969f0d..9a07b4bc03 100644 --- a/docs/types/classes/_text_.text.html +++ b/docs/types/classes/_text_.text.html @@ -2151,7 +2151,7 @@

constructor

⊕ new Text(value?: Text | string | AnyU8a | object): Text

-

Defined in Text.ts:23

+

Defined in Text.ts:23

Parameters:

@@ -2185,7 +2185,7 @@

encodedLength

getencodedLength(): number

-

Defined in Text.ts:45

+

Defined in Text.ts:45

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

Returns: number


@@ -2193,7 +2193,7 @@

length

getlength(): number

Overrides String.length

-

Defined in Text.ts:52

+

Defined in Text.ts:52

description: The length of the value

Returns: number


@@ -2202,7 +2202,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in Text.ts:60

+

Defined in Text.ts:60

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

Parameters:

@@ -2225,7 +2225,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Returns a hex string representation of the value

Returns: string


@@ -2233,7 +2233,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Text.ts:76

+

Defined in Text.ts:76

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

Returns: any


@@ -2242,7 +2242,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides String.toString

-

Defined in Text.ts:83

+

Defined in Text.ts:83

description: Returns the string representation of the value

Returns: string


@@ -2250,7 +2250,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in Text.ts:92

+

Defined in Text.ts:92

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

Parameters:

@@ -2316,7 +2316,7 @@ diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md index 324fb600ce..ec0bb55464 100644 --- a/docs/types/classes/_text_.text.md +++ b/docs/types/classes/_text_.text.md @@ -27,7 +27,7 @@ ⊕ **new Text**(value?: *[Text](_text_.text.md) | `string` | [AnyU8a](../modules/_types_.md#anyu8a) | `object`*): [Text](_text_.text.md) -*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L23)* +*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L23)* **Parameters:** @@ -61,7 +61,7 @@ ___ getencodedLength(): `number` -*Defined in [Text.ts:45](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L45)* +*Defined in [Text.ts:45](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L45)* *__description__*: The length of the value when encoded as a Uint8Array @@ -76,7 +76,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L52)* +*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L52)* *__description__*: The length of the value @@ -94,7 +94,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L60)* +*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L60)* *__description__*: Compares the value of the input to see if there is a match @@ -115,7 +115,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L69)* *__description__*: Returns a hex string representation of the value @@ -130,7 +130,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L76)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -147,7 +147,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L83)* +*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L83)* *__description__*: Returns the string representation of the value @@ -162,7 +162,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [Text.ts:92](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L92)* +*Defined in [Text.ts:92](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L92)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_.type.html b/docs/types/classes/_type_.type.html index 3690be8544..929165e030 100644 --- a/docs/types/classes/_type_.type.html +++ b/docs/types/classes/_type_.type.html @@ -2152,7 +2152,7 @@

constructor

⊕ new Type(value?: Text | Uint8Array | string): Type

Overrides Text.constructor

-

Defined in Type.ts:19

+

Defined in Type.ts:19

Parameters:

@@ -2179,7 +2179,7 @@

encodedLength

getencodedLength(): number

Overrides Text.encodedLength

-

Defined in Type.ts:76

+

Defined in Type.ts:76

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

Returns: number


@@ -2188,7 +2188,7 @@

getlength(): number

Inherited from Text.length

Overrides String.length

-

Defined in Text.ts:52

+

Defined in Text.ts:52

description: The length of the value

Returns: number


@@ -2198,7 +2198,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Text.eq

-

Defined in Text.ts:60

+

Defined in Text.ts:60

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

Parameters:

@@ -2222,7 +2222,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Text.toHex

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Returns a hex string representation of the value

Returns: string


@@ -2231,7 +2231,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Text.toJSON

-

Defined in Text.ts:76

+

Defined in Text.ts:76

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

Returns: any


@@ -2241,7 +2241,7 @@

Implementation of Codec.toString

Inherited from Text.toString

Overrides String.toString

-

Defined in Text.ts:83

+

Defined in Text.ts:83

description: Returns the string representation of the value

Returns: string


@@ -2250,7 +2250,7 @@

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

Implementation of Codec.toU8a

Overrides Text.toU8a

-

Defined in Type.ts:87

+

Defined in Type.ts:87

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

Parameters:

@@ -2316,7 +2316,7 @@ diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md index d4c17ba3ec..dedc9924be 100644 --- a/docs/types/classes/_type_.type.md +++ b/docs/types/classes/_type_.type.md @@ -29,7 +29,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L19)* +*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Overrides [Text](_text_.text.md).[encodedLength](_text_.text.md#encodedlength)* -*Defined in [Type.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L76)* +*Defined in [Type.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L76)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L52)* +*Defined in [Text.ts:52](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L52)* *__description__*: The length of the value @@ -88,7 +88,7 @@ ___ *Inherited from [Text](_text_.text.md).[eq](_text_.text.md#eq)* -*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L60)* +*Defined in [Text.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L60)* *__description__*: Compares the value of the input to see if there is a match @@ -111,7 +111,7 @@ ___ *Inherited from [Text](_text_.text.md).[toHex](_text_.text.md#tohex)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L69)* *__description__*: Returns a hex string representation of the value @@ -128,7 +128,7 @@ ___ *Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L76)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -147,7 +147,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Text.ts#L83)* +*Defined in [Text.ts:83](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Text.ts#L83)* *__description__*: Returns the string representation of the value @@ -164,7 +164,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:87](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Type.ts#L87)* +*Defined in [Type.ts:87](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Type.ts#L87)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u128_.u128.html b/docs/types/classes/_u128_.u128.html index 1e4622f25c..7f973d8f49 100644 --- a/docs/types/classes/_u128_.u128.html +++ b/docs/types/classes/_u128_.u128.html @@ -2150,7 +2150,7 @@

constructor

⊕ new U128(value?: AnyNumber): U128

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md index 6c7017f1dd..80e418ba3a 100644 --- a/docs/types/classes/_u128_.u128.md +++ b/docs/types/classes/_u128_.u128.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U128.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u16_.u16.html b/docs/types/classes/_u16_.u16.html index 95a81b194e..59ffae7d63 100644 --- a/docs/types/classes/_u16_.u16.html +++ b/docs/types/classes/_u16_.u16.html @@ -2149,7 +2149,7 @@

constructor

⊕ new U16(value?: AnyNumber): U16

Overrides UInt.constructor

-

Defined in U16.ts:14

+

Defined in U16.ts:14

Parameters:

@@ -2174,7 +2174,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2184,7 +2184,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2250,7 +2250,7 @@ diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md index 9ad0c54ea2..a53a8332e9 100644 --- a/docs/types/classes/_u16_.u16.md +++ b/docs/types/classes/_u16_.u16.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U16.ts#L14)* +*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U16.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u256_.u256.html b/docs/types/classes/_u256_.u256.html index e7ae877014..c7a608b64a 100644 --- a/docs/types/classes/_u256_.u256.html +++ b/docs/types/classes/_u256_.u256.html @@ -2149,7 +2149,7 @@

constructor

⊕ new U256(value?: AnyNumber): U256

Overrides UInt.constructor

-

Defined in U256.ts:14

+

Defined in U256.ts:14

Parameters:

@@ -2174,7 +2174,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2184,7 +2184,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2250,7 +2250,7 @@ diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md index f2e642bb28..498c461b57 100644 --- a/docs/types/classes/_u256_.u256.md +++ b/docs/types/classes/_u256_.u256.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U256.ts#L14)* +*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U256.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u32_.u32.html b/docs/types/classes/_u32_.u32.html index f3e3483e8a..983371a1db 100644 --- a/docs/types/classes/_u32_.u32.html +++ b/docs/types/classes/_u32_.u32.html @@ -2159,7 +2159,7 @@

constructor

⊕ new U32(value?: AnyNumber): U32

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2184,7 +2184,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2194,7 +2194,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2260,7 +2260,7 @@ diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md index ad6f67c0eb..92b888d12f 100644 --- a/docs/types/classes/_u32_.u32.md +++ b/docs/types/classes/_u32_.u32.md @@ -44,7 +44,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -70,7 +70,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -89,7 +89,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u64_.u64.html b/docs/types/classes/_u64_.u64.html index df6597b05a..4a91a1f0ee 100644 --- a/docs/types/classes/_u64_.u64.html +++ b/docs/types/classes/_u64_.u64.html @@ -2153,7 +2153,7 @@

constructor

⊕ new U64(value?: AnyNumber): U64

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2178,7 +2178,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2188,7 +2188,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2254,7 +2254,7 @@ diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md index 38203beae3..b50539d2b5 100644 --- a/docs/types/classes/_u64_.u64.md +++ b/docs/types/classes/_u64_.u64.md @@ -32,7 +32,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U64.ts#L14)* **Parameters:** @@ -58,7 +58,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -77,7 +77,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u8_.u8.html b/docs/types/classes/_u8_.u8.html index c30793a147..de17888ba8 100644 --- a/docs/types/classes/_u8_.u8.html +++ b/docs/types/classes/_u8_.u8.html @@ -2149,7 +2149,7 @@

constructor

⊕ new U8(value?: AnyNumber): U8

Overrides UInt.constructor

-

Defined in U8.ts:14

+

Defined in U8.ts:14

Parameters:

@@ -2174,7 +2174,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2184,7 +2184,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2250,7 +2250,7 @@ diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md index 5b66e52d9b..90f442601c 100644 --- a/docs/types/classes/_u8_.u8.md +++ b/docs/types/classes/_u8_.u8.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U8.ts#L14)* +*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U8.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_usize_.usize.md b/docs/types/classes/_usize_.usize.md index bc8cdb5481..12064a9e1e 100644 --- a/docs/types/classes/_usize_.usize.md +++ b/docs/types/classes/_usize_.usize.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.html b/docs/types/classes/_validatorprefs_.validatorprefs.html index 7bc774bed1..2e7c2fc180 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.html +++ b/docs/types/classes/_validatorprefs_.validatorprefs.html @@ -2154,7 +2154,7 @@

constructor

⊕ new ValidatorPrefs(value?: ValidatorPrefsValue | Uint8Array): ValidatorPrefs

Overrides Struct.constructor

-

Defined in ValidatorPrefs.ts:22

+

Defined in ValidatorPrefs.ts:22

Parameters:

@@ -2178,7 +2178,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2186,21 +2186,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


unstakeThreshold

getunstakeThreshold(): U32

-

Defined in ValidatorPrefs.ts:33

+

Defined in ValidatorPrefs.ts:33

description: The unstake threshold as U32

Returns: U32


validatorPayment

getvalidatorPayment(): Compact

-

Defined in ValidatorPrefs.ts:40

+

Defined in ValidatorPrefs.ts:40

description: The payment config for the validator as a Compact Balance

Returns: Compact


@@ -2210,7 +2210,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

-

Defined in codec/Struct.ts:158

+

Defined in codec/Struct.ts:158

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

Parameters:

@@ -2234,7 +2234,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns a specific names entry in the structure

Parameters:

@@ -2259,7 +2259,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

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

Parameters:

@@ -2282,7 +2282,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2291,7 +2291,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Returns a hex string representation of the value

Returns: string


@@ -2300,7 +2300,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:194

+

Defined in codec/Struct.ts:194

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

Returns: any


@@ -2309,7 +2309,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:208

+

Defined in codec/Struct.ts:208

description: Returns the string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

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

Implementation of Codec.toU8a

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:216

+

Defined in codec/Struct.ts:216

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

Parameters:

@@ -2345,7 +2345,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2408,7 +2408,7 @@ diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md index 0583c5ed38..653af536ca 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ValidatorPrefs.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ValidatorPrefs.ts#L22)* +*Defined in [ValidatorPrefs.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ValidatorPrefs.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getunstakeThreshold(): [U32](_u32_.u32.md) -*Defined in [ValidatorPrefs.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ValidatorPrefs.ts#L33)* +*Defined in [ValidatorPrefs.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ValidatorPrefs.ts#L33)* *__description__*: The unstake threshold as [U32](_u32_.u32.md) @@ -92,7 +92,7 @@ ___ getvalidatorPayment(): [Compact](_codec_compact_.compact.md) -*Defined in [ValidatorPrefs.ts:40](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ValidatorPrefs.ts#L40)* +*Defined in [ValidatorPrefs.ts:40](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ValidatorPrefs.ts#L40)* *__description__*: The payment config for the validator as a [Compact](_codec_compact_.compact.md) [Balance](_balance_.balance.md) @@ -112,7 +112,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L158)* +*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L158)* *__description__*: Compares the value of the input to see if there is a match @@ -135,7 +135,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns a specific names entry in the structure @@ -156,7 +156,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L173)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -177,7 +177,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L180)* *__description__*: Converts the Object to an standard JavaScript Array @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L187)* *__description__*: Returns a hex string representation of the value @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L194)* +*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L194)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L208)* +*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L208)* *__description__*: Returns the string representation of the value @@ -245,7 +245,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L216)* +*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L216)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_vote_.vote.md b/docs/types/classes/_vote_.vote.md index 5efbf50d9f..d22a795ee3 100644 --- a/docs/types/classes/_vote_.vote.md +++ b/docs/types/classes/_vote_.vote.md @@ -24,7 +24,7 @@ *Overrides [I8](_i8_.i8.md).[constructor](_i8_.i8.md#constructor)* -*Defined in [Vote.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Vote.ts#L14)* +*Defined in [Vote.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Vote.ts#L14)* **Parameters:** @@ -44,7 +44,7 @@ ___ getisAye(): `boolean` -*Defined in [Vote.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Vote.ts#L32)* +*Defined in [Vote.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Vote.ts#L32)* *__description__*: true is the wrapped value is a positive vote @@ -57,7 +57,7 @@ ___ getisNay(): `boolean` -*Defined in [Vote.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Vote.ts#L39)* +*Defined in [Vote.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Vote.ts#L39)* *__description__*: true is the wrapped value is a negative vote @@ -79,7 +79,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -98,7 +98,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_voteindex_.voteindex.html b/docs/types/classes/_voteindex_.voteindex.html index 7aaa186c19..12a741556f 100644 --- a/docs/types/classes/_voteindex_.voteindex.html +++ b/docs/types/classes/_voteindex_.voteindex.html @@ -2150,7 +2150,7 @@

⊕ new VoteIndex(value?: AnyNumber): VoteIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2175,7 +2175,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2185,7 +2185,7 @@

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2251,7 +2251,7 @@ diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md index 657a753dda..432014e454 100644 --- a/docs/types/classes/_voteindex_.voteindex.md +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_votethreshold_.votethreshold.html b/docs/types/classes/_votethreshold_.votethreshold.html index 0dfdb6f00c..070ac29742 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.html +++ b/docs/types/classes/_votethreshold_.votethreshold.html @@ -2147,7 +2147,7 @@

constructor

⊕ new VoteThreshold(index?: number | Uint8Array): VoteThreshold

Overrides Enum.constructor

-

Defined in VoteThreshold.ts:12

+

Defined in VoteThreshold.ts:12

Parameters:

@@ -2171,7 +2171,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

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

Returns: number


@@ -2181,7 +2181,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Enum.eq

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

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

Parameters:

@@ -2205,7 +2205,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:84

+

Defined in codec/Enum.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2214,7 +2214,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:91

+

Defined in codec/Enum.ts:91

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

Returns: any


@@ -2222,7 +2222,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:98

+

Defined in codec/Enum.ts:98

description: Returns the number representation for the value

Returns: number


@@ -2231,7 +2231,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:105

+

Defined in codec/Enum.ts:105

description: Returns the string representation of the value

Returns: string


@@ -2240,7 +2240,7 @@

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

Implementation of Codec.toU8a

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:113

+

Defined in codec/Enum.ts:113

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

Parameters:

@@ -2267,7 +2267,7 @@

<Static> decodeEnum

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

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2331,7 +2331,7 @@ diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md index e527e3381f..e5795a1102 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/VoteThreshold.ts#L12)* +*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/VoteThreshold.ts#L12)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L71)* *__description__*: Compares the value of the input to see if there is a match @@ -89,7 +89,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L84)* +*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -106,7 +106,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -121,7 +121,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L98)* *__description__*: Returns the number representation for the value @@ -138,7 +138,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the string representation of the value @@ -155,7 +155,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L113)* +*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L113)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -176,7 +176,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md index cb023fb97e..f67b90a20f 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -22,7 +22,7 @@ **Compact**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L19)* ___ @@ -31,7 +31,7 @@ ___ **Enum**: -*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L20)* +*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L20)* ___ @@ -40,7 +40,7 @@ ___ **Option**: -*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L21)* +*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L21)* ___ @@ -49,7 +49,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L22)* ___ @@ -58,7 +58,7 @@ ___ **Struct**: -*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L23)* +*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L23)* ___ @@ -67,7 +67,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:24](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L24)* +*Defined in [codec/createType.ts:24](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L24)* ___ @@ -76,7 +76,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L25)* +*Defined in [codec/createType.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L25)* ___ diff --git a/docs/types/index.html b/docs/types/index.html index 650d2acdd9..cd3eec7325 100644 --- a/docs/types/index.html +++ b/docs/types/index.html @@ -2184,7 +2184,7 @@ diff --git a/docs/types/interfaces/_metadata_types_.metadatainterface.md b/docs/types/interfaces/_metadata_types_.metadatainterface.md index 045baeea28..3a3b1efd31 100644 --- a/docs/types/interfaces/_metadata_types_.metadatainterface.md +++ b/docs/types/interfaces/_metadata_types_.metadatainterface.md @@ -19,7 +19,7 @@ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata/types.ts:6](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/types.ts#L6)* +*Defined in [Metadata/types.ts:6](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/types.ts#L6)* **Returns:** `Array`<`string`> diff --git a/docs/types/interfaces/_method_.methodfunction.md b/docs/types/interfaces/_method_.methodfunction.md index ad38d5035b..6dbad09cdf 100644 --- a/docs/types/interfaces/_method_.methodfunction.md +++ b/docs/types/interfaces/_method_.methodfunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...args: *`any`[]*): [Method](../classes/_method_.method.md) -*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L28)* +*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L28)* **Parameters:** @@ -25,7 +25,7 @@ **● callIndex**: *`Uint8Array`* -*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L30)* +*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L30)* ___ @@ -34,7 +34,7 @@ ___ **● meta**: *[FunctionMetadata](../classes/_metadata_v0_modules_.functionmetadata.md)* -*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L31)* +*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L31)* ___ @@ -43,7 +43,7 @@ ___ **● method**: *`string`* -*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L32)* +*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L32)* ___ @@ -52,7 +52,7 @@ ___ **● section**: *`string`* -*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L33)* +*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L33)* ___ @@ -61,7 +61,7 @@ ___ **● toJSON**: *`function`* -*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Method.ts#L34)* +*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md index 7d865209cc..b51ba3b735 100644 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L12)* +*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_v0_modules_.storagefunctionmetadata.md)* -*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L14)* +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L15)* +*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L16)* +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StorageKey.ts#L17)* +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_types_.codec.md b/docs/types/interfaces/_types_.codec.md index cc0e5e50ac..8368ee629e 100644 --- a/docs/types/interfaces/_types_.codec.md +++ b/docs/types/interfaces/_types_.codec.md @@ -88,8 +88,8 @@ * [KeyValueOption](../classes/_keyvalue_.keyvalueoption.md) * [LocKPeriods](../classes/_lockperiods_.lockperiods.md) * [MagicNumber](../classes/_metadata_magicnumber_.magicnumber.md) -* [MapType](../classes/_metadata_v0_modules_.maptype.md) * [MapType](../classes/_metadata_v1_storage_.maptype.md) +* [MapType](../classes/_metadata_v0_modules_.maptype.md) * [Metadata](../classes/_metadata_index_.metadata.md) * [MetadataCall](../classes/_metadata_v1_calls_.metadatacall.md) * [MetadataCallArg](../classes/_metadata_v1_calls_.metadatacallarg.md) @@ -185,7 +185,7 @@ **● encodedLength**: *`number`* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L34)* *__description__*: The length of the value when encoded as a Uint8Array @@ -199,7 +199,7 @@ ___ ▸ **eq**(other?: *`any`*): `boolean` -*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L39)* *__description__*: Compares the value of the input to see if there is a match @@ -218,7 +218,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L44)* *__description__*: Returns a hex string representation of the value @@ -231,7 +231,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L49)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -244,7 +244,7 @@ ___ ▸ **toString**(): `string` -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L54)* *__description__*: Returns the string representation of the value @@ -257,7 +257,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [types.ts:60](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md index ec4c26c582..565042e4d7 100644 --- a/docs/types/modules/_accountindex_.md +++ b/docs/types/modules/_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [AccountIndex.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/AccountIndex.ts#L12)* +*Defined in [AccountIndex.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/AccountIndex.ts#L12)* ___ diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md index 7d2be8a2a1..97595f4c37 100644 --- a/docs/types/modules/_address_.md +++ b/docs/types/modules/_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Address.ts#L15)* +*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Address.ts#L15)* ___ diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md index 8f972e600f..ee7a4e02c1 100644 --- a/docs/types/modules/_bft_.md +++ b/docs/types/modules/_bft_.md @@ -22,7 +22,7 @@ **Ƭ BftAuthoritySignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L12)* +*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L12)* ___ @@ -31,7 +31,7 @@ ___ **Ƭ BftHashSignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Bft.ts#L43)* +*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Bft.ts#L43)* ___ diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md index b7d2db05e9..9f9b8f4c61 100644 --- a/docs/types/modules/_block_.md +++ b/docs/types/modules/_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Block.ts#L14)* +*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Block.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_classes_.md b/docs/types/modules/_classes_.md index 3f7981e944..6514c9ede7 100644 --- a/docs/types/modules/_classes_.md +++ b/docs/types/modules/_classes_.md @@ -8,7 +8,7 @@ **Ƭ CodecTypes**: *`keyof "/home/travis/build/polkadot-js/api/packages/types/src/index"`* -*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/classes.ts#L7)* +*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/classes.ts#L7)* ___ diff --git a/docs/types/modules/_codec_abstractint_.md b/docs/types/modules/_codec_abstractint_.md index d6505b9ad8..7daa06e97e 100644 --- a/docs/types/modules/_codec_abstractint_.md +++ b/docs/types/modules/_codec_abstractint_.md @@ -8,7 +8,7 @@ **Ƭ UIntBitLength**: *`8` | `16` | `32` | `64` | `128` | `256`* -*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/AbstractInt.ts#L10)* +*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/AbstractInt.ts#L10)* ___ @@ -20,7 +20,7 @@ ___ **● DEFAULT_UINT_BITS**: *`64`* = 64 -*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/AbstractInt.ts#L12)* +*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/AbstractInt.ts#L12)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index 8352d73ee0..4768a5c8c9 100644 --- a/docs/types/modules/_codec_createtype_.md +++ b/docs/types/modules/_codec_createtype_.md @@ -28,7 +28,7 @@ **Ƭ TypeDef**: *`object`* -*Defined in [codec/createType.ts:28](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L28)* +*Defined in [codec/createType.ts:28](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L28)* #### Type declaration @@ -42,7 +42,7 @@ ___ ▸ **createClass**(type: *[Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:195](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L195)* +*Defined in [codec/createType.ts:195](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L195)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **createType**(type: *[Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/createType.ts:201](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L201)* +*Defined in [codec/createType.ts:201](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L201)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:139](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L139)* +*Defined in [codec/createType.ts:139](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L139)* **Parameters:** @@ -95,7 +95,7 @@ ___ ▸ **getTypeDef**(_type: *[Text](../classes/_text_.text.md) | `string`*, name?: *`undefined` | `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:84](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L84)* +*Defined in [codec/createType.ts:84](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L84)* **Parameters:** @@ -113,7 +113,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:36](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/createType.ts#L36)* +*Defined in [codec/createType.ts:36](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/createType.ts#L36)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_comparearray_.md b/docs/types/modules/_codec_utils_comparearray_.md index d027a2fc73..773ba2ec0b 100644 --- a/docs/types/modules/_codec_utils_comparearray_.md +++ b/docs/types/modules/_codec_utils_comparearray_.md @@ -8,7 +8,7 @@ ▸ **compareArray**(a: *`Array`<`any`>*, b?: *`any`*): `boolean` -*Defined in [codec/utils/compareArray.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/utils/compareArray.ts#L9)* +*Defined in [codec/utils/compareArray.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/utils/compareArray.ts#L9)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_comparemap_.md b/docs/types/modules/_codec_utils_comparemap_.md index 7cfcc309c7..9b028b1929 100644 --- a/docs/types/modules/_codec_utils_comparemap_.md +++ b/docs/types/modules/_codec_utils_comparemap_.md @@ -8,7 +8,7 @@ ▸ **compareMap**(a: *`Map`<`any`, `any`>*, b?: *`any`*): `boolean` -*Defined in [codec/utils/compareMap.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/utils/compareMap.ts#L9)* +*Defined in [codec/utils/compareMap.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/utils/compareMap.ts#L9)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_decodeu8a_.md b/docs/types/modules/_codec_utils_decodeu8a_.md index 429901a4c7..3492ba0806 100644 --- a/docs/types/modules/_codec_utils_decodeu8a_.md +++ b/docs/types/modules/_codec_utils_decodeu8a_.md @@ -8,7 +8,7 @@ ▸ **decodeU8a**(u8a: *`Uint8Array`*, _types: *[Constructor](_types_.md#constructor)[] | `object`*): [Codec](../interfaces/_types_.codec.md)[] -*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/codec/utils/decodeU8a.ts#L14)* +*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/codec/utils/decodeU8a.ts#L14)* Given an u8a, and an array of Type constructors, decode the u8a against the types, and return an array of decoded values. diff --git a/docs/types/modules/_extrinsicsignature_.md b/docs/types/modules/_extrinsicsignature_.md index 714360d05d..4066b8d13d 100644 --- a/docs/types/modules/_extrinsicsignature_.md +++ b/docs/types/modules/_extrinsicsignature_.md @@ -24,7 +24,7 @@ **Ƭ SignatureOptions**: *`object`* -*Defined in [ExtrinsicSignature.ts:18](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L18)* +*Defined in [ExtrinsicSignature.ts:18](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L18)* #### Type declaration @@ -38,7 +38,7 @@ ___ **● IMMORTAL_ERA**: *`Uint8Array`* = new Uint8Array([0]) -*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/ExtrinsicSignature.ts#L25)* +*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/ExtrinsicSignature.ts#L25)* ___ diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md index 6142fc3729..e605ebb1fd 100644 --- a/docs/types/modules/_header_.md +++ b/docs/types/modules/_header_.md @@ -21,7 +21,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Header.ts#L17)* +*Defined in [Header.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Header.ts#L17)* #### Type declaration diff --git a/docs/types/modules/_justification_.md b/docs/types/modules/_justification_.md index 0581c12a07..c95f5be875 100644 --- a/docs/types/modules/_justification_.md +++ b/docs/types/modules/_justification_.md @@ -21,7 +21,7 @@ **Ƭ RhdJustificationValue**: *`object`* -*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Justification.ts#L14)* +*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Justification.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md index 370c43360e..4aaf462d27 100644 --- a/docs/types/modules/_keyvalue_.md +++ b/docs/types/modules/_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *[[AnyU8a](_types_.md#anyu8a), `undefined` | `string` | `Uint8Array` | `number`[]]* -*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/KeyValue.ts#L49)* +*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/KeyValue.ts#L49)* ___ diff --git a/docs/types/modules/_metadata_magicnumber_.md b/docs/types/modules/_metadata_magicnumber_.md index 5c12d62b09..1256ac984c 100644 --- a/docs/types/modules/_metadata_magicnumber_.md +++ b/docs/types/modules/_metadata_magicnumber_.md @@ -21,7 +21,7 @@ **● MAGIC_ERROR**: *`-61746`* = -61746 -*Defined in [Metadata/MagicNumber.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MagicNumber.ts#L9)* +*Defined in [Metadata/MagicNumber.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MagicNumber.ts#L9)* ___ @@ -30,7 +30,7 @@ ___ **● MAGIC_NUMBER**: *[U32](../classes/_u32_.u32.md)* = new U32(0x6174656d) -*Defined in [Metadata/MagicNumber.ts:8](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/MagicNumber.ts#L8)* +*Defined in [Metadata/MagicNumber.ts:8](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/MagicNumber.ts#L8)* ___ diff --git a/docs/types/modules/_metadata_util_flattenuniq_.md b/docs/types/modules/_metadata_util_flattenuniq_.md index bcdef570a3..0e895c99dd 100644 --- a/docs/types/modules/_metadata_util_flattenuniq_.md +++ b/docs/types/modules/_metadata_util_flattenuniq_.md @@ -8,7 +8,7 @@ ▸ **flattenUniq**(list: *`Array`<`any`>*): `Array`<`any`> -*Defined in [Metadata/util/flattenUniq.ts:6](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/util/flattenUniq.ts#L6)* +*Defined in [Metadata/util/flattenUniq.ts:6](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/util/flattenUniq.ts#L6)* **Parameters:** diff --git a/docs/types/modules/_metadata_util_validatetypes_.md b/docs/types/modules/_metadata_util_validatetypes_.md index 1196bdebbd..933ac700a6 100644 --- a/docs/types/modules/_metadata_util_validatetypes_.md +++ b/docs/types/modules/_metadata_util_validatetypes_.md @@ -8,7 +8,7 @@ ▸ **validateTypes**(types: *`Array`<`string`>*): `void` -*Defined in [Metadata/util/validateTypes.ts:10](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/util/validateTypes.ts#L10)* +*Defined in [Metadata/util/validateTypes.ts:10](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/util/validateTypes.ts#L10)* **Parameters:** diff --git a/docs/types/modules/_metadata_v1_tov0_.md b/docs/types/modules/_metadata_v1_tov0_.md index 13ef0a1803..87623ab7ec 100644 --- a/docs/types/modules/_metadata_v1_tov0_.md +++ b/docs/types/modules/_metadata_v1_tov0_.md @@ -8,7 +8,7 @@ ▸ **toV0**(v1: *[MetadataV1](../classes/_metadata_v1_index_.metadatav1.md)*): [MetadataV0](../classes/_metadata_v0_index_.metadatav0.md) -*Defined in [Metadata/v1/toV0.ts:96](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/Metadata/v1/toV0.ts#L96)* +*Defined in [Metadata/v1/toV0.ts:96](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/Metadata/v1/toV0.ts#L96)* **Parameters:** diff --git a/docs/types/modules/_storedpendingchange_.md b/docs/types/modules/_storedpendingchange_.md index 9a658ef91e..d853f70b21 100644 --- a/docs/types/modules/_storedpendingchange_.md +++ b/docs/types/modules/_storedpendingchange_.md @@ -22,7 +22,7 @@ **Ƭ NextAuthorityValue**: *`object`* -*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L15)* +*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L15)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ StoredPendingChangeValue**: *`object`* -*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/StoredPendingChange.ts#L20)* +*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/StoredPendingChange.ts#L20)* #### Type declaration diff --git a/docs/types/modules/_types_.md b/docs/types/modules/_types_.md index 687bbc00cc..340ed938cd 100644 --- a/docs/types/modules/_types_.md +++ b/docs/types/modules/_types_.md @@ -29,7 +29,7 @@ **Ƭ AnyNumber**: *`BN` | `Uint8Array` | `number` | `string`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L17)* ___ @@ -38,7 +38,7 @@ ___ **Ƭ AnyString**: *`string` | `String`* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L19)* ___ @@ -47,7 +47,7 @@ ___ **Ƭ AnyU8a**: *`Uint8Array` | `Array`<`number`> | `string`* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L21)* ___ @@ -56,7 +56,7 @@ ___ **Ƭ CodecArg**: *[Codec](../interfaces/_types_.codec.md) | `BN` | `Boolean` | `String` | `Uint8Array` | `boolean` | `number` | `string` | `undefined` | `CodecArgArray` | `CodecArgObject`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L7)* ___ @@ -65,7 +65,7 @@ ___ **Ƭ CodecCallback**: *`function`* -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L9)* #### Type declaration ▸(result: *`T`*): `any` @@ -85,7 +85,7 @@ ___ **Ƭ CodecTo**: *"toHex" | "toJSON" | "toString" | "toU8a"* -*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L63)* ___ @@ -94,7 +94,7 @@ ___ **Ƭ Constructor**: *`object`* -*Defined in [types.ts:65](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L65)* #### Type declaration @@ -105,7 +105,7 @@ ___ **Ƭ ConstructorDef**: *`object`* -*Defined in [types.ts:67](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L67)* #### Type declaration @@ -118,7 +118,7 @@ ___ **Ƭ RegistryTypes**: *`object`* -*Defined in [types.ts:71](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L71)* #### Type declaration @@ -131,7 +131,7 @@ ___ **Ƭ TypeDef**: *`object`* -*Defined in [types.ts:69](https://github.com/polkadot-js/api/blob/0ef15dc/packages/types/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/polkadot-js/api/blob/be17bf5/packages/types/src/types.ts#L69)* #### Type declaration diff --git a/lerna.json b/lerna.json index 3b124f5a9b..d5a2a1c306 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.42.14" + "version": "0.42.15" } diff --git a/package.json b/package.json index 42d3e40920..6be48a68d8 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.42.14", + "version": "0.42.15", "private": true, "engines": { "node": ">=10.13.0", diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index 283dedb7af..39e3352a7b 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-derive", - "version": "0.42.14", + "version": "0.42.15", "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.", "main": "index.js", "keywords": [ @@ -31,8 +31,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/api": "^0.42.14", - "@polkadot/types": "^0.42.14", + "@polkadot/api": "^0.42.15", + "@polkadot/types": "^0.42.15", "@types/memoizee": "^0.4.2", "@types/rx": "^4.1.1", "memoizee": "^0.4.14", diff --git a/packages/api/package.json b/packages/api/package.json index d2aad45cb6..6888d04d23 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.42.14", + "version": "0.42.15", "description": "An RxJS wrapper around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,12 +30,12 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/api-derive": "^0.42.14", - "@polkadot/extrinsics": "^0.42.14", - "@polkadot/rpc-provider": "^0.42.14", - "@polkadot/rpc-rx": "^0.42.14", - "@polkadot/storage": "^0.42.14", - "@polkadot/types": "^0.42.14", + "@polkadot/api-derive": "^0.42.15", + "@polkadot/extrinsics": "^0.42.15", + "@polkadot/rpc-provider": "^0.42.15", + "@polkadot/rpc-rx": "^0.42.15", + "@polkadot/storage": "^0.42.15", + "@polkadot/types": "^0.42.15", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index d05a550c6f..3bde3a965c 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.42.14", + "version": "0.42.15", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/jsonrpc": "^0.42.14", - "@polkadot/rpc-provider": "^0.42.14", - "@polkadot/types": "^0.42.14", + "@polkadot/jsonrpc": "^0.42.15", + "@polkadot/rpc-provider": "^0.42.15", + "@polkadot/types": "^0.42.15", "@polkadot/util": "^0.33.36" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index b99e37486c..6869896fea 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.42.14", + "version": "0.42.15", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.36", - "@polkadot/storage": "^0.42.14", + "@polkadot/storage": "^0.42.15", "@polkadot/util": "^0.33.36", "@polkadot/util-crypto": "^0.33.36", "@types/nock": "^9.3.0", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index 1966329a92..22c1c757a5 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.42.14", + "version": "0.42.15", "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.2.0", - "@polkadot/rpc-core": "^0.42.14", - "@polkadot/rpc-provider": "^0.42.14", + "@polkadot/rpc-core": "^0.42.15", + "@polkadot/rpc-provider": "^0.42.15", "@types/memoizee": "^0.4.2", "@types/rx": "^4.1.1", "memoizee": "^0.4.14", diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index 15af33e929..3207d40471 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.42.14", + "version": "0.42.15", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", @@ -11,7 +11,7 @@ "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/types": "^0.42.14", + "@polkadot/types": "^0.42.15", "@polkadot/util": "^0.33.36" } } diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 52272399f1..4db46636a6 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.42.14", + "version": "0.42.15", "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 c2eb6a5f75..a4189a3baf 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.42.14", + "version": "0.42.15", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.36", - "@polkadot/types": "^0.42.14", + "@polkadot/types": "^0.42.15", "@polkadot/util": "^0.33.36", "@polkadot/util-crypto": "^0.33.36" } diff --git a/packages/types/package.json b/packages/types/package.json index 6bf347110b..deeb847501 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.42.14", + "version": "0.42.15", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [