api/docs at 71c5920b1ffb1a6cd9c9840ecdb27e28fc706735 - api

Files

T

Jaco Greeff 71c5920b1f eslint rules (#1099 )

* Off to the races - 3760 problems (1794 errors, 1966 warnings)

* Convert Array<T> -> T[] (not all correct, eg. extends)

* () => { -> (): void  => {

* get is/as -> public get is/as

* public for getters, constructors & base Codec

* Some cleanups from previous overzealous search & replace

* Under 2k, 1874 problems (649 errors, 1225 warnings)

* ^^^ check that commit for details ;)

* Minor.

* rm config header

* Minor cleanups

* Default to tslint, eslint as option

* Trigger

* Update jsonrpc

* 1494 problems (433 errors, 1061 warnings)

* 1103 problems (135 errors, 968 warnings)

* 899 problems (9 errors, 890 warnings)

* 483 problems (9 errors, 474 warnings) (ignore any... for now)

* 366 problems (9 errors, 357 warnings)

* 336 problems (9 errors, 327 warnings)

* 148 problems (9 errors, 139 warnings)

* 31 problems (8 errors, 23 warnings)

* 0, 0

2019-07-14 12:15:14 +02:00

.vuepress

Align with intro and links to other parts (#751 )

2019-03-01 12:43:16 +01:00

examples

eslint rules (#1099 )

2019-07-14 12:15:14 +02: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

METHODS_EVENTS.md

[CI Skip] 0.82.0-beta.50

2019-07-12 10:00:40 +00:00

METHODS_EXTRINSICS.md

[CI Skip] 0.82.0-beta.50

2019-07-12 10:00:40 +00:00

METHODS_RPC.md

[CI Skip] 0.82.0-beta.11

2019-06-18 16:10:11 +00:00

METHODS_STORAGE.md

[CI Skip] 0.82.0-beta.50

2019-07-12 10:00:40 +00:00

README.md

Align with intro and links to other parts (#751 )

2019-03-01 12:43:16 +01:00

SUMMARY.md

Cleanup old docs/ (now on gh-pages branch) (#747 )

2019-02-28 17:22:42 +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 Examples In a rush and just want examples? Jump right in and get a handle on using the API in your projects. :::

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.