$ npm install --global reasonably-typed
// class.js
declare module 'classes' {
declare type State = {
id: number,
storeName: string
};
declare export class Store {
constructor(initialState: State): Store;
state: State;
update(nextState: State): void;
}
}
$ retyped class.js
/* Module classes */
type state = Js.t {. id : float, storeName : string};
module Store = {
type t = Js.t {. state : state, update : (state => unit) [@bs.meth]};
external make : state => t = "Store" [@@bs.new] [@@bs.module "classes"];
};
TypeScript
TypeScript has a similar workflow. Compile your TypeScript file with:
$ retyped my-definition.d.ts
Command-line Usage
Usage:
$ retyped ...files
Examples:
$ retyped file1.js file2.js file3.d.ts [boolean]
Usage as a library
ReasonablyTyped also exports a library for use! See the example below:// lib-usage.js
import * as ReasonablyTyped from 'reasonably-typed'
const libSrc = fs.readFileSync('lib.js').toString()
const bsInterface = ReasonablyTyped.compile(libSrc)
format (code: string) => string
Formats a block of code using refmt
compile (code: string, filename?: string) => string
Compiles a libdef, formats the result, and handles errors cleanly
See DEVELOPING and CONTRIBUTING.
- Basic types like
string
- Function types
- Record types
- Literals as types
- Union types
- Instersection types
- Named types
- Optional parameters
- Classes
- Generics
- Built-ins like Promises
- React components