@tanssi/api-augment

Description

TypeScript type definitions that can be used to decorate the @polkadot/api.

Installation

``bash
npm i @tanssi/api-augment
`

> :warning: @polkadot/api should be installed in your project!

Usage

Add to your codebase entry point before any imports from the API itself.

- import '@tanssi/api-augment' - applies Dancebox types and endpoint augmentation
- import '@tanssi/api-augment/dancebox' - applies Dancebox types and endpoint augmentation
- import '@tanssi/api-augment/flashbox' - applies Flashbox types and endpoint augmentation

Docs

- @polkadot/api - TS type generation
- @polkadot/api - Since upgrading to the 7.x series, TypeScript augmentation is missing
- @polkadot/api - TypeScript interfaces

Publish

Update package version.

`bash
npm version --no-git-tag-version 0.1500.0
`

Generate new types.

`bash
npm run generate
`

The version change and new generated types should be merged to master.

Build the package.

`bash
npm run build
`

This will build the package and copy necessary files to the build folder.

`bash
npm run publish
`

This will publish content of the build folder.`