Index of modules


A
Array [Js]
Provide bindings to Js array
ArrayBuffer [Js_typed_array]

B
Boolean [Js]
Provide utilties for Js.boolean
Bs
place holder for BuckleScript datastructures
Bs_dyn
An experimentation of runtime types in OCaml, unstable API, only for internal use
Bs_dyn_lib
experimental API
Buffer [Node]

C
Child_process [Node]

D
DataView [Js_typed_array]
Date [Js]
Provide bindings for JS Date
Dict [Js]
Provide utilities for JS dictionary object
Dom
Dom_storage
Dyn [Bs]
/
Dyn_lib [Bs]

E
Exn [Js]
Provide utilities for dealing with Js exceptions

F
Float [Js]
Provide utilities for JS float
Float32Array [Js_typed_array]
Float32_array [Js_typed_array]
Float64Array [Js_typed_array]
Float64_array [Js_typed_array]
Fs [Node]

G
Global [Js]
Provide bindings to JS global functions in global namespace

I
Int [Js]
Provide utilities for int
Int16Array [Js_typed_array]
Int32Array [Js_typed_array]
Int32_array [Js_typed_array]
Int8Array [Js_typed_array]

J
Js
This library provides bindings and necessary support for JS FFI. It contains all bindings into Js namespace.
Js_array
JavaScript Array API
Js_boolean
Contains functions for dealing with JavaScript booleans
Js_cast
Safe cast between OCaml values which share the same runtime representation

Different OCaml types might share the same represention in the BuckleScript runtime; while this is a compiler internal knowledge, applications might benefit from having a safe and zero cost conversion between those types.

This modules acts as the single place for such conversion.

If for any reason, the runtime representation changes, those function will be modified accordingly.

Js_date
JavaScript Date API
Js_dict
Dictionary type (ie an '{ }' JS object). However it is restricted to hold a single type; therefore values must have the same type.

This Dictionary type is mostly use with the Js_json.t type.

Js_exn
Used by the compiler internally
Js_float
Provides functions for inspecting and manipulating floats
Js_global
Contains functions available in the global scope (window in a browser context)
Js_int
Provides functions for inspecting and manipulating ints
Js_int64
Js_internal
Internal types which are used to support uncurry and method, they are not supposed to be exposed to external users
Js_json
Efficient JSON encoding using JavaScript API
Js_list
Application order is left to right, tail recurisve
Js_math
JavaScript Math API
Js_nativeint
Js_null
Provides functionality for dealing with the 'a Js.null type
Js_null_undefined
Contains functionality for dealing with values that can be both null and undefined
Js_obj
Provides functions for inspecting and maniplating native JavaScript objects
Js_option
Js_primitive
Js_promise
Specialized bindings to Promise, note for simplicity, this binding does not track the error type, it treat it as an opaque type
    

Js_re
Provides bindings for JavaScript Regular Expressions

Syntax sugar

BuckleScript provides a bit of syntax sugar for regex literals: [%re "/foo/g"] will evaluate to a Js_re.t that can be passed around and used like usual.

Note: This is not an immutable API. A RegExp object with the global ("g") flag set will modify the Js_re.lastIndex property when the RegExp object is used, and subsequent uses will ocntinue the search from the previous Js_re.lastIndex.

Js_result
Js_string
JavaScript String API
Js_typed_array
JavaScript Typed Array API
Js_types
Js_undefined
Provides functionality for dealing with the 'a Js.undefined type
Js_unsafe
Js_vector
shallow copy
Json [Js]
Provide utilities for json

L
List [Js]
Provide utilties for list

M
Math [Js]
Provide bindings for JS Math object
Module [Node]

N
Node
place holder for node bindings
Node_buffer
Node Buffer API
Node_child_process
Node Child Process API
Node_fs
Node FS API
Node_module
Node Module API
Node_path
Node Path API
Node_process
The process.uptime() method returns the number of seconds the current Node.js process has been running.)
Null [Js]
Provide utilities arond 'a null
Null_undefined [Js]
Nullable [Js]
Provide utilities arond Js.null_undefined

O
Obj [Js]
Provide utilities for Js.t
Option [Js]
Provide utilities for option

P
Path [Node]
Process [Node]
Promise [Js]
Provide bindings to JS promise

R
Re [Js]
Provide bindings to Js regex expression
Result [Js]
definie the interface for result

S
Storage [Dom]
String [Js]
Provide bindings to JS string

T
Typed_array [Js]
Provide bindings for JS typed array
Types [Js]
Provide utilities for maninpulatig JS types

U
Uint16Array [Js_typed_array]
Uint32Array [Js_typed_array]
Uint8Array [Js_typed_array]
Uint8ClampedArray [Js_typed_array]
Undefined [Js]
Provide utilities around Js.undefined

V
Vector [Js]

W
Watch [Node_fs]