api/docs at 044efbc6de4980dbabb5461c9d802c9c91634280 - api

Files

T

Jaco Greeff 044efbc6de Convert jsonrpc & typings to definitions (#2064 )

* Convert jsonrpc & typings to definitions

* Handle empty interface generation (no types)

* Move jsonrpc/create to rpc-core/create

* Create imports

* Remove jsonrpc package, generate rpc-core from defs

* Debug :)

* Generate RPC definitions via interfaces

* Generate md docs

* Remove @polkadot/jsonrpc refs (at least packages)

* No empty types

* Add PAHNTOM "cleanup" gen

* *sigh* regex loop

* Update mock for no jsonrpc

* Add definition export types

* Cleanup linting

* Mocking 1 fix

* Mocking 2 fix

* rpc-core tests updates

* CHANGELOG & docs

* Add jsonrpc (already mapped) to interfaces

* Add aliasses for RPCs

* Fix rpc-core tests

2020-03-19 14:40:54 +01:00

.vuepress

Convert jsonrpc & typings to definitions (#2064 )

2020-03-19 14:40:54 +01:00

examples

Fix link to GH source

2020-02-26 13:30:19 +01:00

start

Convert jsonrpc & typings to definitions (#2064 )

2020-03-19 14:40:54 +01:00

substrate

Format documentation strings properly & refactor MetadataMd (#1858 )

2020-02-15 08:35:15 +01:00

.nojekyll

Add .nojekyll (_ in filenames) (#160 )

2018-09-19 16:59:09 +02:00

logo.png

docs: Relates to #268 . Add Polkadot white logo. Match styles to apps (#277 )

2018-10-13 16:38:29 +02:00

README.md

Things I wish I knew... (#1374 )

2019-09-11 17:32:34 +02:00

SUMMARY.md

Add polkadot-types-from-{chain,defs} (#1766 )

2020-01-29 15:51:23 +01:00

README.md

home, heroText, tagline, features, footer

home

heroText

tagline

features

footer

true

title	details
API	A powerful dynamic API that allows chain interactions with transparent encoding and decoding.

title	details
Substrate defaults	An overview of the various default methods, state entries and RPCs for Substrate-based chains.

title	details
Types	Various type interfaces to make using returned values from API calls transparent in your code.

Welcome

The API provides application developers the ability to query a node and interact with the Polkadot or Substrate chains using Javascript. Here you will find documentation and examples to get you started.

::: tip Getting started & Examples Jump right in and get an overview on using the API in your projects, from installation all the way through to making it do magic. Already understand how things work and just want the examples? The ApiPromise examples provide some basic recipies. :::

Available packages

This repository split up into a number of internal packages, namely -

api Promise and RxJS-based APIs
types Type encoding and decoding wrappers

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/ and more about the polkadot-js projects at https://polkadot.js.org

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/api

Contributing

Contribution to the Polkadot JS API are more than welcome. You can report issues and log feature requests.