quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
15022986597cf978e8bb7c9437c0f5c991eaf2b4
api/docs/SUMMARY.md
T
Stefanie Doll 2433d8d1fc WIP: Sd 569 docs add and fix apirx examples (#600) 
* Docs: Fixed keyring examples

* Docs: Added Rx examples

* [Docs] Added timeout to showcase unsubscribe method in ApiPromise

* [Docs] Added timeout to showcase unsubscribe method in ApiPromise

* [Docs] Added comments to read_storage example

* [Docs] Renamed "transfer_dots' to a more generic 'make_transfer' since it's not only DOT's

* [Docs] ApiRx examples for simple_connect, listen_to_blocks (incl. unsubscribe), listen_to_balance_change and read_storage

* [Docs] changed back keyring import syntax to require

* [Docs] Removed provider from read storage example

* [Docs] ApiRx "make transfer" example

* [Docs] ApiRx "system events" example

* [Docs] ApiRx "transfer events" example

* [Docs] Removed unused utility functions import

* [Docs] ApiRx 'upgrade chain' example

* [Docs] removed generated html files

* [Docs] Ficed wrong Readme of listen to blocks example

* [Docs added missing import]

* [Docs] Removed unsubscribe() example from 'listen to blocks'

* [Docs] Added Unsubscribe example for ApiPromise and ApiRx

* [Docs] Added links to summary

* [Docs] Removed duplicate info/comment from 04_unsubscribe

* [Docs] Fixed wording

* [Docs] Log actual transaction status in "make_transfer"

* [Docs] Changed author name

* [Docs] Log actual transaction status in "make_transfer"

* [Docs] changed headline of make_transfer example README's

* [Docs] changed status.value to status.asFinalised

* [Docs] Removed auto-generated html

* [Docs] Changed all occurances of status.value.toHex() to status.asFinalised.toHex()

* [Docs] Remove call to nonce observable from signAndSend examples

* [Docs] Use RxJs' zip() operator instead of 'await Promise.all()'

* [Docs] Remove call to nonce observable from 'upgrade_chain' example

* [Docs] Changed author

* [Docs] Changed wording of balance change example

* [Docs] smaller code-review fixes

* [Docs] Fix Rx read_storage example

* [Docs] use pairwise together with startWith in the Rx balance_change example

* [Docs] Wording & little less code

* [Docs] Added whitespace

* [Docs] Use switchMap instead fo subscribe inside subscribe syntax

* [Docs] Fixed import syntax for RxJs examples

* [Docs] removed provider

* [Docs] WIP read storage make-over

* [Docs] update Rx read_storage

* [Docs] Read storage example with piped switchMap()

* [Docs] Turn null into observable

* [Docs] Read storage example added 2nd version using tap()

* [Docs] fixed name typo

* [Docs] removed tap() example
2019-01-22 11:47:27 +01:00

160 lines
8.1 KiB
Markdown
Raw Blame History

## Packages
- [api](api/README.md)
- [ApiPromise](api/classes/_promise_index_.apipromise.md)
- [ApiRx](api/classes/_rx_index_.apirx.md)
- [rpc-provider](rpc-provider/README.md)
- [HttpProvider](rpc-provider/classes/_http_index_.httpprovider.md)
- [WsProvider](rpc-provider/classes/_ws_index_.wsprovider.md)
- [types (codec implementation)](types/README.md)
## Interfaces
- [RPC](METHODS_RPC.md)
- [Chain state (runtime)](METHODS_STORAGE.md)
- [Extrinsics (runtime)](METHODS_EXTRINSICS.md)
- [Events (runtime)](METHODS_EVENTS.md)
## Examples
- [ApiPromise](examples/promise/README.md)
- [Simple connect](examples/promise/01_simple_connect/README.md)
- [Listen to blocks](examples/promise/02_listen_to_blocks/README.md)
- [Listen to balance change](examples/promise/03_listen_to_balance_change/README.md)
- [Unsubscribe from listening](examples/promise/04_unsubscribe/README.md)
- [Read chain state](examples/promise/05_read_storage/README.md)
- [Make a transfer](examples/promise/06_make_transfer/README.md)
- [Display system events](examples/promise/08_system_events/README.md)(
- [Transaction with events](examples/promise/09_transfer_events/README.md)
- [Upgrade via sudo](examples/promise/10_upgrade_chain/README.md)
- [ApiRx](examples/rx/README.md)
- [Simple connect](examples/rx/01_simple_connect/README.md)
- [Listen to blocks](examples/rx/02_listen_to_blocks/README.md)
- [Listen to balance change](examples/rx/03_listen_to_balance_change/README.md)
- [Unsubscribe from listening](examples/rx/04_unsubscribe/README.md)
- [Read chain state](examples/rx/05_read_storage/README.md)
- [Make a transfer](examples/rx/06_make_transfer/README.md)
- [Display system events](examples/rx/08_system_events/README.md)(
- [Transaction with events](examples/rx/09_transfer_events/README.md)
- [Upgrade via sudo](examples/rx/10_upgrade_chain/README.md)
<!-- These are hidden, allowing HTML generation but does not appear in the sidebar -->
- [hidden](types/classes/_accountid_.accountid.md)
- [hidden](types/classes/_accountindex_.accountindex.md)
- [hidden](types/classes/_address_.address.md)
- [hidden](types/classes/_authorityid_.authorityid.md)
- [hidden](types/classes/_balance_.balance.md)
- [hidden](types/classes/_bft_.bftauthoritysignature.md)
- [hidden](types/classes/_bft_.bfthashsignature.md)
- [hidden](types/classes/_block_.block.md)
- [hidden](types/classes/_blocknumber_.blocknumber.md)
- [hidden](types/classes/_bool_.bool.md)
- [hidden](types/classes/_bytes_.bytes.md)
- [hidden](types/classes/_chainproperties_.chainproperties.md)
- [hidden](types/classes/_codec_base_.base.md)
- [hidden](types/classes/_codec_compact_.compact.md)
- [hidden](types/classes/_codec_enum_.enum.md)
- [hidden](types/classes/_codec_enumtype_.enumtype.md)
- [hidden](types/classes/_codec_option_.option.md)
- [hidden](types/classes/_codec_set_.set.md)
- [hidden](types/classes/_codec_struct_.struct.md)
- [hidden](types/classes/_codec_tuple_.tuple.md)
- [hidden](types/classes/_codec_typeregistry_.typeregistry.md)
- [hidden](types/classes/_codec_u8a_.u8a.md)
- [hidden](types/classes/_codec_u8afixed_.u8afixed.md)
- [hidden](types/classes/_codec_uint_.uint.md)
- [hidden](types/classes/_codec_vector_.vector.md)
- [hidden](types/classes/_data_.data.md)
- [hidden](types/classes/_digest_.authoritieschange.md)
- [hidden](types/classes/_digest_.changestrieroot.md)
- [hidden](types/classes/_digest_.digest.md)
- [hidden](types/classes/_digest_.digestitem.md)
- [hidden](types/classes/_digest_.other.md)
- [hidden](types/classes/_digest_.seal.md)
- [hidden](types/classes/_event_.event.md)
- [hidden](types/classes/_event_.eventdata.md)
- [hidden](types/classes/_event_.eventindex.md)
- [hidden](types/classes/_eventrecord_.applyextrinsic.md)
- [hidden](types/classes/_eventrecord_.eventrecord.md)
- [hidden](types/classes/_eventrecord_.finalization.md)
- [hidden](types/classes/_eventrecord_.phase.md)
- [hidden](types/classes/_extrinsic_.extrinsic.md)
- [hidden](types/classes/_extrinsicera_.extrinsicera.md)
- [hidden](types/classes/_extrinsics_.extrinsics.md)
- [hidden](types/classes/_extrinsicsignature_.extrinsicsignature.md)
- [hidden](types/classes/_extrinsicstatus_.broadcast.md)
- [hidden](types/classes/_extrinsicstatus_.dropped.md)
- [hidden](types/classes/_extrinsicstatus_.extrinsicstatus.md)
- [hidden](types/classes/_extrinsicstatus_.finalised.md)
- [hidden](types/classes/_extrinsicstatus_.usurped.md)
- [hidden](types/classes/_gas_.gas.md)
- [hidden](types/classes/_h256_.h256.md)
- [hidden](types/classes/_h512_.h512.md)
- [hidden](types/classes/_hash_.hash.md)
- [hidden](types/classes/_header_.header.md)
- [hidden](types/classes/_justification_.justification.md)
- [hidden](types/classes/_justification_.rhdjustification.md)
- [hidden](types/classes/_keyvalue_.keyvalue.md)
- [hidden](types/classes/_keyvalue_.keyvalueoption.md)
- [hidden](types/classes/_metadata_.callmetadata.md)
- [hidden](types/classes/_metadata_.eventmetadata.md)
- [hidden](types/classes/_metadata_.functionargumentmetadata.md)
- [hidden](types/classes/_metadata_.functionmetadata.md)
- [hidden](types/classes/_metadata_.modulemetadata.md)
- [hidden](types/classes/_metadata_.outerdispatchcall.md)
- [hidden](types/classes/_metadata_.outerdispatchmetadata.md)
- [hidden](types/classes/_metadata_.outereventmetadata.md)
- [hidden](types/classes/_metadata_.outereventmetadataevent.md)
- [hidden](types/classes/_metadata_.runtimemetadata.md)
- [hidden](types/classes/_metadata_.runtimemodulemetadata.md)
- [hidden](types/classes/_metadata_.storagefunctionmetadata.md)
- [hidden](types/classes/_metadata_.storagefunctionmodifier.md)
- [hidden](types/classes/_metadata_.storagefunctiontype.md)
- [hidden](types/classes/_metadata_.storagefunctiontype_map.md)
- [hidden](types/classes/_metadata_.storagemetadata.md)
- [hidden](types/classes/_method_.method.md)
- [hidden](types/classes/_method_.methodindex.md)
- [hidden](types/classes/_misbehaviorreport_.bftatreport.md)
- [hidden](types/classes/_misbehaviorreport_.bftdoublecommit.md)
- [hidden](types/classes/_misbehaviorreport_.bftdoubleprepare.md)
- [hidden](types/classes/_misbehaviorreport_.bftdoublepropose.md)
- [hidden](types/classes/_misbehaviorreport_.bftproposeoutofturn.md)
- [hidden](types/classes/_misbehaviorreport_.misbehaviorkind.md)
- [hidden](types/classes/_misbehaviorreport_.misbehaviorreport.md)
- [hidden](types/classes/_moment_.moment.md)
- [hidden](types/classes/_newaccountoutcome_.newaccountoutcome.md)
- [hidden](types/classes/_nonce_.nonce.md)
- [hidden](types/classes/_null_.null.md)
- [hidden](types/classes/_origin_.origin.md)
- [hidden](types/classes/_parachainid_.parachainid.md)
- [hidden](types/classes/_pendingextrinsics_.pendingextrinsics.md)
- [hidden](types/classes/_perbill_.perbill.md)
- [hidden](types/classes/_permill_.permill.md)
- [hidden](types/classes/_propindex_.propindex.md)
- [hidden](types/classes/_proposal_.proposal.md)
- [hidden](types/classes/_proposalindex_.proposalindex.md)
- [hidden](types/classes/_referendumindex_.referendumindex.md)
- [hidden](types/classes/_runtimeversion_.apiid.md)
- [hidden](types/classes/_runtimeversion_.runtimeversion.md)
- [hidden](types/classes/_runtimeversion_.runtimeversionapi.md)
- [hidden](types/classes/_sessionkey_.sessionkey.md)
- [hidden](types/classes/_signature_.signature.md)
- [hidden](types/classes/_signaturepayload_.signaturepayload.md)
- [hidden](types/classes/_signedblock_.signedblock.md)
- [hidden](types/classes/_storagechangeset_.storagechangeset.md)
- [hidden](types/classes/_storagedata_.storagedata.md)
- [hidden](types/classes/_storagekey_.storagekey.md)
- [hidden](types/classes/_storedpendingchange_.nextauthority.md)
- [hidden](types/classes/_storedpendingchange_.storedpendingchange.md)
- [hidden](types/classes/_text_.text.md)
- [hidden](types/classes/_type_.type.md)
- [hidden](types/classes/_u128_.u128.md)
- [hidden](types/classes/_u16_.u16.md)
- [hidden](types/classes/_u256_.u256.md)
- [hidden](types/classes/_u32_.u32.md)
- [hidden](types/classes/_u64_.u64.md)
- [hidden](types/classes/_u8_.u8.md)
- [hidden](types/classes/_validatorprefs_.validatorprefs.md)
- [hidden](types/classes/_voteindex_.voteindex.md)
- [hidden](types/classes/_votethreshold_.votethreshold.md)
Reference in New Issue View Git Blame Copy Permalink