Skip to content

wise-team/types-for-steem-js

Repository files navigation

@types/steem-js-alpha

Typescript definitions for steem-js library.

Warning

This types are an aplha release. We have spent some time in writing declarations for various steem-js functions. Responses from steem are complex, and writing type definitions for them takes a lot of time. Our goal is to prepare complete type definitions for all functions and responses of steem-js lib. Typescript lovers - stay tuned! :D When they are finished, we will rename the package to @types/steem-js;

This types are not yet submitted to DefinitelyTyped as they are not ready. To use them you have to include link to git repository in package.json/dependencies. More info about using git repositories in dependencies (and how to specify semver) can be found here: https://docs.npmjs.com/files/package.json#git-urls-as-dependencies . Master branch always contains stable work.

Installation

Add the following to your dependencies:

{
    "devDependencies": {
        "...": "...",
        "@types/steem-js-alpha": "git+https://github.com/wise-team/types-for-steem-js.git",
        "...": "...
    }
}

or if your CI/docker image does not support git:

{
    "devDependencies": {
        "...": "...",
        "@types/steem-js-alpha": "https://github.com/wise-team/types-for-steem-js/raw/master/bin/types-steem-js-alpha-3.1.2.tgz",
        "...": "...
    }
}

About

Typescript definitions for steem-js library (warning: unfinished yet, contains only functions used by wise).

Resources

License

Stars

Watchers

Forks

Packages

No packages published