T

Jaco Greeff 6cab9be9c8 Document @polkadot/types (#430 )

* Start with codec descriptions

* Base codec types have definitions...

* Base interface defintions

* Descriptions for all type classes

* Link to types docs

* Remove stray template block

* Typos

* Hash -> H256 in description

2018-12-03 11:23:18 +01:00

docs

Document @polkadot/types (#430 )

2018-12-03 11:23:18 +01:00

packages

Document @polkadot/types (#430 )

2018-12-03 11:23:18 +01:00

.babelrc.js

TypeScript conversion (#101 )

2018-06-23 13:39:31 +02:00

.codeclimate.yml

Update to dev 12 (#28 )

2017-12-01 20:57:16 +01:00

.editorconfig

Initial add

2017-11-18 08:38:18 +01:00

.gitignore

Add documentation and examples (#145 )

2018-09-15 09:11:56 +02:00

.npmignore

Move to lerna repo (#19 )

2017-11-28 18:03:48 +01:00

.nvmrc

Add documentation and examples (#145 )

2018-09-15 09:11:56 +02:00

.travis.yml

Yarn 1.10.1 on CI and engines (#348 )

2018-10-25 14:45:31 +02:00

babel.config.js

Use @babel 7 (#90 )

2018-05-16 13:53:29 +02:00

book.json

Absolute logo url (#283 )

2018-10-13 18:01:53 +02:00

jest.config.js

fix: Fixes #221 . Exclude tests files in build directory. Only use those in src (#222 )

2018-10-10 23:31:48 +02:00

lerna.json

[CI Skip] 0.32.16

2018-11-30 14:59:05 +00:00

LICENSE

Update LICENSE and README (#408 )

2018-11-21 13:37:27 +01:00

package.json

[CI Skip] 0.32.16

2018-11-30 14:59:05 +00:00

README.md

Remove api-observable from README (#422 )

2018-11-29 12:37:27 +01:00

tsconfig.json

Bump deps (#345 )

2018-10-24 17:47:01 +02:00

tslint.json

API formatting for inputs & outputs (#171 )

2018-09-28 15:42:23 +02:00

typedoc.js

API documentation (#253 )

2018-10-11 15:27:00 +02:00

yarn.lock

Move types.d.ts -> types.ts (#421 )

2018-11-29 12:13:28 +01:00

README.md

@polkadot/api

This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client and defines all the types exposed by a node. For complete documentation around the classes, interfaces and their use, visit the documentation portal.

tutorials

Looking for tutorials to get started? Look at examples for guides on how to use the API.

overview

The API is split up into a number of internal packages -

@polkadot/api The API library, providing both Promise and RxJS Observable-based interfaces
@polkadot/rpc-core Wrapper around all JSON-RPC methods exposed by a Polkadot network client
@polkadot/rpc-provider Providers for connecting to nodes, including WebSockets and Http
@polkadot/rpc-rx A RxJs Observable wrapper around @polkadot/rpc-provider

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
@polkadot/types Codecs for all Polkadot primitives

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, its 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