bind-to-js-function.mdx

title	description	canonical
Bind to JS Function	JS interop with functions in ReScript	/docs/manual/v11.0.0/bind-to-js-function

Function

Binding a JS function is like binding any other value:

<CodeTab labels={["ReScript", "JS Output"]}>

// Import nodejs' path.dirname @module("path") externaldirname: string=>string="dirname"letroot=dirname("/User/github") // returns "User"

varPath=require("path");varroot=Path.dirname("/User/github");

We also expose a few special features, described below.

Labeled Arguments

ReScript has labeled arguments (that can also be optional). These work on an external too! You'd use them to fix a JS function's unclear usage. Assuming we're modeling this:

// MyGame.jsfunctiondraw(x,y,border){// suppose `border` is optional and defaults to false}draw(10,20)draw(20,20,true)

It'd be nice if on ReScript's side, we can bind & call draw while labeling things a bit:

<CodeTab labels={["ReScript", "JS Output"]}>

@module("MyGame") externaldraw: (~x: int, ~y: int, ~border: bool=?) =>unit="draw"draw(~x=10, ~y=20, ~border=true) draw(~x=10, ~y=20)

varMyGame=require("MyGame");MyGame.draw(10,20,true);MyGame.draw(10,20,undefined);

We've compiled to the same function, but now the usage is much clearer on the ReScript side thanks to labels!

Note that you can freely reorder the labels on the ReScript side; they'll always correctly appear in their declaration order in the JavaScript output:

<CodeTab labels={["ReScript", "JS Output"]}>

@module("MyGame") externaldraw: (~x: int, ~y: int, ~border: bool=?) =>unit="draw"draw(~x=10, ~y=20) draw(~y=20, ~x=10)

varMyGame=require("MyGame");MyGame.draw(10,20,undefined);MyGame.draw(10,20,undefined);

Object Method

Functions attached to JS objects (other than JS modules) require a special way of binding to them, using send:

<CodeTab labels={["ReScript", "JS Output"]}>

typedocument// abstract type for a document object @sendexternalgetElementById: (document, string) =>Dom.element="getElementById" @valexternaldoc: document="document"letel=getElementById(doc, "myId")

varel=document.getElementById("myId");

In a send, the object is always the first argument. Actual arguments of the method follow (this is a bit what modern OOP objects are really).

Chaining

Ever used foo().bar().baz() chaining ("fluent api") in JS OOP? We can model that in ReScript too, through the pipe operator.

Nested function call

@send can also accept a @scope(("itemOne","itemTwo")) to access a function on a nested property.

<CodeTab labels={["ReScript", "JS Output"]}>

typestripe @module("stripe") @newexternalmake: string=>stripe="default"typecreateSession= {} typesessionResult @send @scope(("checkout", "sessions")) externalcreateCheckoutSession: (stripe, createSession) =>Promise.t<sessionResult> ="create"letstripe=make("sk_...") letsession=stripe->createCheckoutSession({})

importStripefrom"stripe";varstripe=newStripe("sk_...");varsession=stripe.checkout.sessions.create({});

Variadic Function Arguments

You might have JS functions that take an arbitrary amount of arguments. ReScript supports modeling those, under the condition that the arbitrary arguments part is homogenous (aka of the same type). If so, add variadic to your external.

<CodeTab labels={["ReScript", "JS Output"]}>

@module("path") @variadicexternaljoin: array<string> =>string="join"letv=join(["a", "b"])

varPath=require("path");varv=Path.join("a","b");

module will be explained in Import from/Export to JS.

Modeling Polymorphic Function

Apart from the above special-case, JS functions in general are often arbitrarily overloaded in terms of argument types and number. How would you bind to those?

Trick 1: Multiple externals

If you can exhaustively enumerate the many forms an overloaded JS function can take, simply bind to each differently:

<CodeTab labels={["ReScript", "JS Output"]}>

@module("MyGame") externaldrawCat: unit=>unit="draw" @module("MyGame") externaldrawDog: (~giveName: string) =>unit="draw" @module("MyGame") externaldraw: (string, ~useRandomAnimal: bool) =>unit="draw"

// Empty output

Note how all three externals bind to the same JS function, draw.

Trick 2: Polymorphic Variant + unwrap

If you have the irresistible urge of saying "if only this JS function argument was a variant instead of informally being either string or int", then good news: we do provide such external features through annotating a parameter as a polymorphic variant! Assuming you have the following JS function you'd like to bind to:

functionpadLeft(value,padding){if(typeofpadding==="number"){returnArray(padding+1).join(" ")+value;}if(typeofpadding==="string"){returnpadding+value;}thrownewError(`Expected string or number, got '${padding}'.`);}

Here, padding is really conceptually a variant. Let's model it as such.

<CodeTab labels={["ReScript", "JS Output"]}>

@valexternalpadLeft: ( string, @unwrap [ | #Str(string) | #Int(int) ]) =>string="padLeft"padLeft("Hello World", #Int(4)) padLeft("Hello World", #Str("Message from ReScript: "))

padLeft("Hello World",4);padLeft("Hello World","Message from ReScript: ");

Obviously, the JS side couldn't have an argument that's a polymorphic variant! But here, we're just piggy backing on poly variants' type checking and syntax. The secret is the @unwrap annotation on the type. It strips the variant constructors and compile to just the payload's value. See the output.

Constrain Arguments Better

Consider the Node fs.readFileSync's second argument. It can take a string, but really only a defined set: "ascii", "utf8", etc. You can still bind it as a string, but we can use poly variants + string to ensure that our usage's more correct:

<CodeTab labels={["ReScript", "JS Output"]}>

@module("fs") externalreadFileSync: ( ~name: string, @string [ | #utf8 | @as("ascii") #useAscii ], ) =>string="readFileSync"readFileSync(~name="xx.txt", #useAscii)

varFs=require("fs");Fs.readFileSync("xx.txt","ascii");

• Attaching @string to the whole poly variant type makes its constructor compile to a string of the same name.
• Attaching a @as("bla") to a constructor lets you customize the final string.

And now, passing something like "myOwnUnicode" or other variant constructor names to readFileSync would correctly error.

Aside from string, you can also compile an argument to an int, using int instead of string in a similar way:

<CodeTab labels={["ReScript", "JS Output"]}>

@valexternaltestIntType: ( @int [ | #onClosed | @as(20) #onOpen | #inBinary ]) =>int="testIntType"testIntType(#inBinary)

testIntType(21);

onClosed compiles to 0, onOpen to 20 and inBinary to 21.

Unknown for type safety

It is best practice to inspect data received from untrusted external functions to ensure it contains what you expect. This helps avoid run-time crashes and unexpected behavior. If you're certain about what an external function returns, simply assert the return value as string or array<int> or whatever you want it to be. Otherwise use unknown. The ReScript type system will prevent you from using an unknown until you first inspect it and "convert" it using JSON parsing utilities or similar tools.

Consider the example below of two external functions that access the value of a property on a JavaScript object. getPropertyUnsafe returns an 'a, which means "anything you want it to be." ReScript allows you to use this value as a string or array or any other type. Quite convenient! But if the property is missing or contains something unexpected, your code might break. You can make the binding more safe by changing 'a to string or option<'a>, but this doesn't completely eliminate the problem.

The getPropertySafe function returns an unknown, which could be null or a string or anything else. But ReScript prevents you from using this value inappropriately until it has been safely parsed.

@get_indexexternalgetPropertyUnsafe: ({..}, string) =>'a="" @get_indexexternalgetPropertySafe: ({..}, string) =>unknown=""letperson= {"name": "Bob", "age": 12} letgreeting1="Hello, "++getPropertyUnsafe(person, "name") // works (this time!)// let greeting2 = "Hello, " ++ getPropertySafe(person, "name") // syntax error

Special-case: Event Listeners

One last trick with polymorphic variants:

<CodeTab labels={["ReScript", "JS Output"]}>

typereadline @sendexternalon: ( readline, @string [ | #close(unit=>unit) | #line(string=>unit) ] ) =>readline="on"letregister=rl=>rl->on(#close(event=> ())) ->on(#line(line=>Console.log(line)));

functionregister(rl){returnrl.on("close",function($$event){}).on("line",function(line){console.log(line);});}

Fixed Arguments

Sometimes it's convenient to bind to a function using an external, while passing predetermined argument values to the JS function:

<CodeTab labels={["ReScript", "JS Output"]}>

@valexternalprocessOnExit: ( @as("exit") _, int=>unit ) =>unit="process.on"processOnExit(exitCode=>Console.log("error code: "++Int.toString(exitCode)) );

process.on("exit",function(exitCode){console.log("error code: "+exitCode.toString());});

The @as("exit") and the placeholder _ argument together indicates that you want the first argument to compile to the string "exit". You can also use any JSON literal with as: @as(json`true`), @as(json`{"name": "John"}`), etc.

Ignore arguments

You can also explicitly "hide" external function parameters in the JS output, which may be useful if you want to add type constraints to other parameters without impacting the JS side:

<CodeTab labels={["ReScript", "JS Output"]}>

@valexternaldoSomething: (@ignore'a, 'a) =>unit="doSomething"doSomething("this only shows up in ReScript code", "test")

doSomething("test");

Note: It's a pretty niche feature, mostly used to map to polymorphic JS APIs.

Modeling this-based Callbacks

Many JS libraries have callbacks which rely on this (the source), for example:

x.onload=function(v){console.log(this.response+v)}

Here, this would point to x (actually, it depends on how onload is called, but we digress). It's not correct to declare x.onload of type (. unit) -> unit. Instead, we introduced a special attribute, this, which allows us to type x as so:

<CodeTab labels={["ReScript", "JS Output"]}>

typex @valexternalx: x="x" @setexternalsetOnload: (x, @this ((x, int) =>unit)) =>unit="onload" @getexternalresp: x=>int="response"setOnload(x, @this (o, v) =>Console.log(resp(o) +v))

x.onload=function(v){varo=this;console.log((o.response+v)|0);};

@this reserves the first parameter for the this value, and for arity of 0, there is no need for a redundant unit type.

Function Nullable Return Value Wrapping

For JS functions that return a value that can also be undefined or null, we provide @return(...). To automatically convert that value to an option type (recall that ReScript option type's None value only compiles to undefined and not null).

<CodeTab labels={["ReScript", "JS Output"]}>

typeelementtypedom @send @return(nullable) externalgetElementById: (dom, string) =>option<element> ="getElementById"lettest=dom=> { letelem=dom->(getElementById("haha")) switch (elem) { | None=>1 | Some(_ui) =>2 } }

functiontest(dom){varelem=dom.getElementById("haha");if(elem==null){return1;}else{console.log(elem);return2;}}

return(nullable) attribute will automatically convert null and undefined to option type.

Currently 4 directives are supported: null_to_opt, undefined_to_opt, nullable and identity.

identity will make sure that compiler will do nothing about the returned value. It is rarely used, but introduced here for debugging purpose.

Tagged template functions

Since 11.1

Experimental You can easily bind to JS tagged template functions. Tag functions in JS expect as input an array of strings and variadic parameters for the arguments of the interpolation. To bind to those functions in ReScript, the binding signature must have two arrays as arguments, the first one being an array of strings and the second can be an array of anything. You add the @taggedTemplate annotation and you're good to go!

<CodeTab labels={["ReScript", "JS Output"]}>

// see https://bun.sh/docs/runtime/shelltyperesult= {exitCode: int} @module("bun") @taggedTemplateexternalsh: (array<string>, array<string>) =>promise<result> ="$"letfilename="index.res"letresult=awaitsh`ls ${filename}`

import*as$$Bunfrom"bun";varfilename="index.res";varresult=await$$Bun.$`ls ${filename}`;

Notice that it gets compiled to tagged template literals in JS, which allows to use JS tools that only work on the literals and not by calling directly the tag function.

There are plenty of useful JS tools you can bind to, like gql, sql, css and a lot others!