@open-rpc/typings

OpenRPC Typings

A tool to produce language-specific typings given an OpenRPC document.

This package will extract the json-schemas from your document, and give you types for them (and language-specific functionality for dealing with data of that json schema type).

Need help or have a question? Join us on our Discord!

Installing

npm install @open-rpc/typings

CLI

$ open-rpc-typings --help
Usage: cli [options]

Options:
  -v, --version                     print the version number
  -d, --document [openrpcDocument]  JSON string, or a filepath or remote URL pointing to an Open-RPC JSON document (default: "./openrpc.json")
  --output-rs [directory]           path to output dir of Rust typings
  --output-ts [directory]           path to output dir of Typescript typings
  --output-go [directory]           path to output dir of Go typings
  --name-rs [file]                  file name to input of Rust typings (default: "./index")
  --name-ts [file]                  file name to input of Typescript typings (default: "./index")
  --name-go [file]                  file name to input of Go typings (default: "./index")
  -h, --help                        print usage information

JS/TS SDK

import OpenRPCTypings from "@open-rpc/typings";


const typings = new OpenRPCTypings(OpenRPCDocument);

await typings.generate()

const rustTypings = typings.toString("rust");