Reason
Quick StartTryGuideAPICommunityBlogGitHub
Search

ExternalSuggest an edit

external, or "FFI" (foreign function interface), or simply "interop" (for "interoperability") is how Reason communicates with other languages, like C or JavaScript.

Imagine writing a let binding, but with its body omitted and its type mandatorily written down:

external myCFunction: int => string = "theCFunction";
external getElementsByClassName : string => array Dom.element =
  "document.getElementsByClassName" [@@bs.val];

(The above is a BuckleScript-specific external that binds to a JavaScript function of the same name.)

Usage

You'd use an external value/function as if it was a normal let binding.

Tips & Tricks

If you come from a JavaScript background: do take some time to learn about the BuckleScript externals! In the beginning, you'll likely encounter quite a few externals before you get to write 100% pure idiomatic Reason code.

Design Decisions

Reason takes interoperating with existing code very seriously. Our type system has very strong guarantees. However, such strong feature also means that, without a great interop system, it'd be very hard to gradually convert a codebase over to Reason. Fortunately, the FFI allows us to cooperate very well with dirty, existing code. The combination of a sound type system + great interop means that we get the benefits of a traditional gradual type system regarding incremental codebase coverage & conversion, without the downside of such gradual type system: complex features to support existing patterns, slow analysis, diminishing return in terms of type coverage, etc.