node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

ts2fable

ts2fable npm version

Fable parser for TypeScript declaration files.

Usage

Install it with yarn or npm. With yarn it is:

yarn global add ts2fable

With npm it is:

npm install -g ts2fable

Run the ts2fable command on a TypeScript file and also specify the F# output file. The F# namespace in taken from the output filename. In this example, it is Yargs.

yarn add @types/yargs --dev
ts2fable node_modules/@types/yargs/index.d.ts src/Yargs.fs

You can find more information about how to interact with JavaScript from F# here. Please note the parser is not perfect and some tweaking by hand may be needed. Please submit bugs as issues on GitHub.

Contributing

Succesfull builds on the master branch are uploaded and tagged as next. You can help us test these builds by installing them with:

yarn global add ts2fable@next

You may also clone the source code, build, and run it directly from source:

git clone https://github.com/fable-compiler/ts2fable

Please use yarn so you will use the exact same versions of everything that was used during development

yarn
cd src
dotnet restore
dotnet fable yarn-build
node ../dist/ts2fable.js ../node_modules/typescript/lib/typescript.d.ts ../test-compile/TypeScript.fs

You can also have it watch the files with:

dotnet fable yarn-watch

Conventions

Some JavaScript/TypeScript features have no direct translation to F#. Here is a list of common workarounds adopted by the parser to solve these problems:

  • Erased unions: TypeScript union types work differently from F# and its only purpose is to specify the types allowed for a function argument. In F# they are translated as erased unions: they're checked at compiled time but they'll be removed from the generated JS code.
type CanvasRenderingContext2D =
    abstract fillStyle: U3<string, CanvasGradient, CanvasPattern> with get, set
 
let ctx: CanvasRenderingContext2D = failwith "dummy"
ctx.fillStyle <- U3.Case1 "#FF0000"
  • Constructor functions: In JS any function can become a constructor just by calling it with the new keyword. In the parsed files, interfaces with this capability will have a Create method attached:
type CanvasRenderingContext2DType =
    abstract prototype: CanvasRenderingContext2D with get, set
    [<Emit("new $0($1...)")>] abstract Create: unit -> CanvasRenderingContext2D
  • Callable interfaces: In the same way, JS functions are just objects which means applying arguments directly to any object is legal in JS. To convey, the parser attaches an Invoke method to callable interfaces:
type Express =
    inherit Application
    abstract version: string with get, set
    abstract application: obj with get, set
    [<Emit("$0($1...)")>] abstract Invoke: unit -> Application