api/docs at 73d7a57d38d271bff493d88527aba23e2bd9373e - api

Files

T

James Lefrère 73d7a57d38 Add .eq() usage to docs and fix docs typos (#1405 )

* Use `eq` for example

* Use the base `eq` function rather than `===`, so that comparisons are made in a consistent manner in docs

* Add `eq` example

* Add an example of using the `eq` method to the base docs

* Adjust docs/examples

* Fix a number of typos in the static docs and examples
* Adjust various comments in docs examples such that they are written in a consistent case

* Fix metadata docs spacing

* Adjust the metadata documentation generation such that unnecessary spaces are trimmed

2019-09-19 11:43:47 +02:00

.vuepress

Start FAQ (#1386 )

2019-09-12 11:21:14 +02:00

examples

Add .eq() usage to docs and fix docs typos (#1405 )

2019-09-19 11:43:47 +02:00

start

Add .eq() usage to docs and fix docs typos (#1405 )

2019-09-19 11:43:47 +02:00

substrate

[CI Skip] 0.93.0-beta.2

2019-09-16 09:54:08 +00: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

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

2019-09-11 17:32:34 +02: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.