https://github.com/glennsl/bucklescript-ffi-cheatsheet

Last synced: 6 months ago
JSON representation
Host: GitHub
URL: https://github.com/glennsl/bucklescript-ffi-cheatsheet
Owner: glennsl
Created: 2017-04-27T16:59:35.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2019-08-25T17:26:25.000Z (over 6 years ago)
Last Synced: 2025-01-22T00:36:25.013Z (12 months ago)
Size: 6.84 KB
Stars: 163
Watchers: 10
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

awesome-list - bucklescript-ffi-cheatsheet
README

          # BuckleScript FFI cheatsheet

NOTE: The translations given here might not be literally correct. The output will in some instances have been simplified slightly to improve clarity.

## Basic

### [bs.val](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_global_value_code_bs_val_code)

```ml

(* ml *)

external f : 'a -> 'b -> 'ret = "" [@@bs.val]

let ret = f a b

```

```reason

/* re */

[@bs.val] external f : ('a, 'b) => 'ret = "";

let ret = f(a, b);

```

```js

// js

var ret = f(a, b);

```

### [bs.get](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_getter_setter_code_bs_get_code_code_bs_set_code)

```ml

(* ml *)

external f : 'self -> 'ret = "" [@@bs.get]

let ret = f self

```

```reason

/* re */

[@bs.get] external f : 'self => 'ret = "";

let ret = f(self);

```

```js

// js

var ret = self.f;

```

### [bs.set](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_getter_setter_code_bs_get_code_code_bs_set_code)

```ml

(* ml *)

external f : 'self -> 'a -> 'ret = "" [@@bs.set]

let ret = f self a

```

```reason

/* re */

[@bs.set] external f : ('self, 'a) => 'ret = "";

let ret = f(self, a);

```

```js

// js

var ret = self.f = a;

```

### [bs.send](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_method_code_bs_send_code_code_bs_send_pipe_code)

```ml

(* ml *)

external f : 'self -> 'a -> 'b -> 'ret = "" [@@bs.send]

let ret = f self a b

```

```reason

/* re */

[@bs.send] external f : ('self, 'a, 'b) => 'ret = "";

let ret = f(self, a, b);

```

```js

// js

var ret = self.f(a, b);

```

### [bs.send.pipe](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_method_code_bs_send_code_code_bs_send_pipe_code)

```ml

(* ml *)

external f : 'a -> 'b -> 'ret = "" [@@bs.send.pipe: 'self]

let ret = f a b self

(* or *)

let ret = self |> f a b

```

```reason

/* re */

[@bs.send.pipe: 'self] external f : ('a, 'b) => 'ret = "";

let ret = f(a, b, self);

/* or */

let ret = self |> f(a, b);

```

```js

// js

var ret = self.f(a, b);

```

### [bs.new](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_javascript_constructor_code_bs_new_code)

```ml

(* ml *)

external f : unit -> 'ret = "" [@@bs.new]

let ret = f ()

```

```reason

/* re */

[@bs.new] external f : unit => 'ret = "";

let ret = f();

```

```js

// js

var ret = new f();

```

### [bs.module](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_a_value_from_a_module_code_bs_module_code)

```ml

(* ml *)

external f : unit -> unit = "" [@@bs.module "m"]

let _ = f ()

```

```reason

/* re */

[@bs.module "m"] external f : unit => unit = "";

f();

```

```js

// js

var m = require('m');

m.f();

```

### [bs.get_index](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_dynamic_key_access_set_code_bs_set_index_code_code_bs_get_index_code)

```ml

(* ml *)

external f : 'self -> 'key -> 'ret = "" [@@bs.get_index]

let ret = f self key

```

```reason

/* re */

[@bs.get_index] external f : ('self, 'key) => 'ret = "";

let ret = f(self, key);

```

```js

// js

var ret = self[key];

```

### [bs.set_index](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_dynamic_key_access_set_code_bs_set_index_code_code_bs_get_index_code)

```ml

(* ml *)

external f : 'self -> 'key -> 'a -> 'ret = "" [@@bs.set_index]

let ret = f self key a

```

```reason

/* re */

[@bs.set_index] external f : ('self, 'key, 'a) => 'ret = "";

let ret = f(self, key, a);

```

```js

// js

var ret = self[key] = a;

```

## Advanced

### [bs.splice](https://bucklescript.github.io/bucklescript/Manual.html#_splice_calling_convention_bs_splice)

```ml

(* ml *)

external f : 'a -> 'b array -> 'ret = "" [@@bs.val] [@@bs.splice]

let ret = f a [|b1; b2; b3|]

```

```reason

/* re */

[@bs.val] [@bs.splice] external f : ('a, array('b)) => 'ret = "";

let ret = f(a, [|b1, b2, b3|]);

```

```js

// js

var ret = f(a, b1, b2, b3);

```

### [bs.scope](https://bucklescript.github.io/bucklescript/Manual.html#_scoped_values_bs_scope_since_1_7_2)

```ml

(* ml *)

external f : unit -> unit = "" [@@bs.val] [@@bs.scope "a", "b"]

let _ = f ()

```

```reason

/* re */

[@bs.val] [@bs.scope ("a", "b")] external f : unit => unit = "";

f();

```

```js

// js

a.b.f();

```

### [bs.return](https://bucklescript.github.io/bucklescript/Manual.html#_return_value_checking_since_1_5_1)

### [bs.obj](https://bucklescript.github.io/bucklescript/Manual.html#_create_js_objects_using_external)

### [bs.as](https://bucklescript.github.io/bucklescript/Manual.html#_fixed_arguments)

```ml

(* ml *)

external f : 'a -> (_ [@bs.as "b"]) -> 'c -> unit = "" [@@bs.val]

let _ = f a c

```

```reason

/* re */

[@bs.val] external f : ('a, [@bs.as "b"] _, 'c) => unit = "";

f(a, c);

```

```js

// js

f(a, "b", c);

```

### [bs.string](https://bucklescript.github.io/bucklescript/Manual.html#_using_polymorphic_variant_to_model_enums_and_string_types)

```ml

(* ml *)

external f : ([`a] [@bs.string]) -> unit = "" [@@bs.val]

let _ = f `a

```

```reason

/* re */

[@bs.val] external f : ([@bs.string] [`a]) => unit = "";

f(`a);

```

```js

// js

f("a");

```

### [bs.int](https://bucklescript.github.io/bucklescript/Manual.html#_using_polymorphic_variant_to_model_enums_and_string_types)

```ml

(* ml *)

external f : ([`a] [@bs.int]) -> unit = "" [@@bs.val]

let _ = f `a

```

```reason

/* re */

[@bs.val] external f : ([@bs.int] [`a]) => unit = "";

f(`a);

```

```js

// js

f(0);

```

### [bs.unwrap](https://bucklescript.github.io/bucklescript/Manual.html#_using_polymorphic_variant_to_model_arguments_of_multiple_possible_types_since_1_8_3)

```ml

(* ml *)

external f : ([`int of int] [@bs.unwrap]) -> unit = "" [@@bs.val]

let _ = f (`int 42)

```

```reason

/* re */

[@bs.val] external f : ([@bs.unwrap] [`int(int)]) => unit = "";

f(`int(42));

```

```js

// js

f(42);

```

### [bs.ignore](https://bucklescript.github.io/bucklescript/Manual.html#_phantom_arguments_and_ad_hoc_polymorphism)

```ml

(* ml *)

external f : 'a -> ('b [@bs.ignore]) -> 'c -> unit = "" [@@bs.val]

let _ = f a b c

```

```reason

/* re */

[@bs.val] external f : ('a, [@bs.ignore] 'b, 'c) => unit = "";

f(a, b, c);

```

```js

// js

f(a, c);

```

### [bs](https://bucklescript.github.io/bucklescript/Manual.html#__bs_for_explicit_uncurried_callback)

### [bs.uncurry](https://bucklescript.github.io/bucklescript/Manual.html#__bs_uncurry_for_implicit_uncurried_callback_since_1_5_0)

### [bs.this](https://bucklescript.github.io/bucklescript/Manual.html#_bindings_to_code_this_code_based_callbacks_bs_this)

### [bs.open](https://bucklescript.github.io/bucklescript/Manual.html#__code_bs_open_code_type_safe_external_data_source_handling_since_1_7_0)

## Extensions

### [bs.re](https://bucklescript.github.io/bucklescript/Manual.html#_regex_support)

```ml

(* ml *)

let re = [%re "/na/gi"]

```

```reason

/* re */

let re = [%re "/na/gi"];

```

```js

// js

var re = /na/gi;

```

### [bs.obj](https://bucklescript.github.io/bucklescript/Manual.html#_create_js_objects_using_bs_obj)

```ml

(* ml *)

let obj = [%obj { property = "value" }]

```

```reason

/* re */

let obj = [%obj { property: "value" }];

/* or */

let obj = { "property": "value" };

```

```js

// js

var obj = {

  property: "value"

};

```

### [bs.raw](https://bucklescript.github.io/bucklescript/Manual.html#_embedding_raw_js_code_as_statements)

#### Expression

```ml

(* ml *)

let raw = [%raw "1 + 2 == 3"]

```

```reason

/* re */

let raw = [%raw "1 + 2 == 3"];

```

```js

// js

var raw = (1 + 2 == 3);

```

#### Function

```ml

(* ml *)

let myFunction = [%raw fun a b -> "return a + b;"];

```

```reason

/* re */

let myFunction = [%raw (a, b) => "return a + b;"];

```

```js

// js

function myFunction (a, b) { return a + b; };

```

#### Block

```ml

(* ml *)

[%%raw {|

  var a = 1;

  var b = a + 2;

|}]

```

```reason

/* re */

[%%raw {|

  var a = 1;

  var b = a + 2;

|}];

```

```js

// js

var a = 1;

var b = a + 2;

```

### [bs.debugger](https://bucklescript.github.io/bucklescript/Manual.html#_debugger_support)

```ml

(* ml *)

[%debugger]

```

```reason

/* re */

[%debugger];

```

```js

// js

debugger;

```

### [bs.external](https://bucklescript.github.io/bucklescript/Manual.html#_detect_global_variable_existence_code_bs_external_code_since_1_5_1)

### [bs.node](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_nodejs_special_variables_bs_node)

## JS Objects

### [Js.t](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_js_objects)

### [##](https://bucklescript.github.io/bucklescript/Manual.html#_binding_to_js_objects)

### [class type ... end \[@bs\]](https://bucklescript.github.io/bucklescript/Manual.html#_complex_object_type)

### [#=](https://bucklescript.github.io/bucklescript/Manual.html#_how_to_consume_js_property_and_methods)

### [bs.get](https://bucklescript.github.io/bucklescript/Manual.html#_getter_setter_annotation_to_js_properties)

### [bs.set](https://bucklescript.github.io/bucklescript/Manual.html#_getter_setter_annotation_to_js_properties)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/glennsl/bucklescript-ffi-cheatsheet

Awesome Lists containing this project

README
