(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * In addition to the permissions granted to you by the LGPL, you may combine
 * or link a "work that uses the Library" with a publicly distributed version
 * of this file to produce a combined library or application, then distribute
 * that combined work under the terms of your choosing, with no requirement
 * to comply with the obligations normally placed on you by section 4 of the
 * LGPL version 3 (or the corresponding section of a later version of the LGPL
 * should you choose to use a later version).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)

type t 

type exn += private Error of t 

external asJsExn : exn -> t option = 
  "caml_as_js_exn"

external stack : t -> string option = "stack"
  [@@bs.get] 
external message : t -> string option = "message"
  [@@bs.get] 
external name : t -> string option = "name"
  [@@bs.get] 
external fileName : t -> string option = "fileName"
  [@@bs.get] 


external isCamlExceptionOrOpenVariant:
  'a -> bool = "caml_is_extension"
(** internal use only *)

val anyToExnInternal: 'a -> exn
(**
 * [anyToExnInternal obj] will take any value [obj] and wrap it
 * in a Js.Exn.Error if given value is not an exn already. If
 * [obj] is an exn, it will return [obj] without any changes. 
 *
 * This function is mostly useful for cases where you want to unify a type of a value
 * that potentially is either exn, a JS error, or any other JS value really (e.g. for 
 * a value passed to a Promise.catch callback) 
 *
 * IMPORTANT: This is an internal API and may be changed / removed any time in the future.
 *
 * @example {[
 *   switch (Js.Exn.unsafeAnyToExn("test")) {
 *     | Js.Exn.Error(v) =>
 *       switch(Js.Exn.message(v)) {
 *         | Some(str) => Js.log("We won't end up here")
           | None => Js.log2("We will land here: ", v)
 *       }
 *   }
 * ]}
 * **)

(** Raise Js exception Error object with stacktrace *)
val raiseError : string -> 'a
val raiseEvalError : string -> 'a
val raiseRangeError : string -> 'a
val raiseReferenceError :  string -> 'a
val raiseSyntaxError : string -> 'a
val raiseTypeError : string -> 'a
val raiseUriError :  string -> 'a