Getting started

Glutinum generates an F# binding from the TypeScript declarations of a JavaScript package. The binding is a single .fs file you add to a Fable project.

Requirements

Node.js 20 or later
A Fable project, with the Fable.Core package

Generate a binding

Install the package whose binding you want, then run Glutinum on it:

Terminal

npm install chalk
npx @glutinum/cli chalk --out-file Glutinum.Chalk.fs

The first line of the generated file says which NuGet packages it needs. Every binding needs Glutinum.Types. A binding that uses the DOM or Node types also needs Glutinum.Web or Glutinum.Node.

Terminal

dotnet add package Glutinum.Types
# Optional
dotnet add package Glutinum.Node
dotnet add package Glutinum.Web

Add the file to the project before the files that use it:

MyApp.fsproj

<ItemGroup>
    <Compile Include="Glutinum.Chalk.fs" />
    <Compile Include="Program.fs" />
</ItemGroup>

Use it

Functions and constructors are static members of the Exports type of the binding. Open it with open type and call them like any F# member:

Program.fs

open Glutinum.Chalk

printfn "%s" (chalk.red "Hello")

Without installing

The web application runs the same generator in the browser. Paste a .d.ts file or name a package, and copy the result.

Edit this page