Luke Schoen
fd596a1eb4
* fix: Modify TypeDocs that change the source to resolve rendering correctly * Add TypeDoc/TSDoc labels * Use HTML <BR> element in TypeDoc to generate new lines even to achieve a newline between lines of code * Use HTML <PRE><CODE> combination in TypeDoc for multiple line code generation * Add missing TypeDocs for HTTP `constructor` and `send` for HTTP and WS * Remove unnecessary assignment of `= true` default value in TypeDoc @param value and clean up text alignment * Verified that it displays correctly in development environment by running `yarn; yarn polkadot-dev-build-docs; yarn gitbook serve`, and then navigating to localhost:4000 * fix: remove signature that was used with jsdocs flowtype
@polkadot/api
This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client. For complete documentation around the classes, interfaces and their use, visit the documentation portal.
overview
The API is split up into a number of internal packages -
- @polkadot/api The low-level base API library
- @polkadot/api-codec Codecs for all Polkadot primitives
- @polkadot/api-rx A RxJs Observable wrapper around the API
- @polkadot/api-provider Providers for connecting
Type definitions for interfaces as exposed by Polkadot & Substrate clients -
- @polkadot/extrinsics Base extrinsic definitions & codecs
- @polkadot/jsonrpc Definitions for JSONRPC endpoints
- @polkadot/storage Definitions for storage entries
development
Contributions are welcome!
To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organise the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.
To get started -
- Clone the repo locally, via
git clone https://github.com/polkadot-js/api <optional local path> - Ensure that you have a recent version of Node.js, for development purposes Node 10 is recommended.
- Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.3.2 is required.
- Install the dependencies by running
yarn - Build the API Docs, via
yarn run build - Ready! Now you can launch the API Docs, via
yarn gitbook serve - Access the API Docs via http://localhost:4000
tutorials
Looking for tutorials to get started? Look at examples for guides on how to use the API.