sfcc-dts
Version:
> High quality Salesforce Commerce Cloud type definitions. A dw-api-types "done right"
1,348 lines • 2.8 MB
JSON
{
"api": {
"TopLevel": {
"APIException": {
"fullClassName": "TopLevel.APIException",
"package": "TopLevel",
"description": "This error indicates an exceptional outcome of some business logic. Instances of\n this exception in general provide additional information about the reason of this case.\n See the actual type referred by the type property for the description of the properties\n with this additional information.\n <br><br>\n Limitation: The sub classes of this APIException shown in this documentation actually do not exist.\n All instances are of type APIException, but with different property sets as listed in the sub classes.\n <br><br>\n The APIException is always related to a systems internal Java exception. The class provides\n access to some more details about this internal Java exception.",
"hierarchy": [
{
"name": "Object"
},
{
"name": "TopLevel.Error"
}
],
"constants": {},
"properties": {
"causeFullName": {
"name": "causeFullName",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "If the exception is associated with a root cause, the property\n contains the full name of the associated Java exception.",
"deprecated": false,
"type": "property"
},
"causeMessage": {
"name": "causeMessage",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "If the exception is associated with a root cause, the property\n contains the message of the associated Java exception.",
"deprecated": false,
"type": "property"
},
"causeName": {
"name": "causeName",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "If the exception is associated with a root cause, the property\n contains the simplified name of the associated Java exception.",
"deprecated": false,
"type": "property"
},
"javaFullName": {
"name": "javaFullName",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "The full name of the underlying Java exception.",
"deprecated": false,
"type": "property"
},
"javaMessage": {
"name": "javaMessage",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "The message of the underlying Java exception.",
"deprecated": false,
"type": "property"
},
"javaName": {
"name": "javaName",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "The simplified name of the underlying Java exception.",
"deprecated": false,
"type": "property"
},
"type": {
"name": "type",
"class": {
"name": "String"
},
"static": false,
"readonly": false,
"description": "The name of the actual APIException type, without the package name.",
"deprecated": false,
"type": "property"
}
},
"constructors": {
"APIException": {
"name": "APIException",
"args": [],
"class": {
"description": ""
},
"description": "",
"deprecated": false
}
},
"methods": {}
},
"Array": {
"fullClassName": "TopLevel.Array",
"package": "TopLevel",
"description": "An Array of items.",
"hierarchy": [
{
"name": "Object"
}
],
"constants": {},
"properties": {
"length": {
"name": "length",
"class": {
"name": "Number"
},
"static": false,
"readonly": false,
"description": "The length of the Array.",
"deprecated": false,
"type": "property"
}
},
"constructors": {
"Array": {
"name": "Array",
"args": [],
"class": {
"description": ""
},
"description": "Constructs an Array.",
"deprecated": false
},
"Array0": {
"name": "Array",
"args": [
{
"name": "length",
"description": "the length of the Array.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Constructs an Array of the specified\n length.",
"deprecated": false
},
"Array01": {
"name": "Array",
"args": [
{
"name": "values",
"description": "zero or more values that are stored in the Array.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"class": {
"description": ""
},
"description": "Constructs an Array using the specified values.",
"deprecated": false
}
},
"methods": {
"concat": {
"name": "concat",
"args": [
{
"name": "values",
"description": "one or more Array values.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"class": {
"name": "Array",
"description": "a new Array containing the concatenated values."
},
"description": "Constructs an Array by concatenating multiple values.",
"deprecated": false
},
"copyWithin": {
"name": "copyWithin",
"args": [
{
"name": "target",
"description": "The target of the first element to copy.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "start",
"description": "Optional. The first index to copy. Default is 0.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "end",
"description": "Optional. The index of the end. This element is not included. Default is copy all to the array end.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "This array."
},
"description": "Copies elements within this array. The array length is not changed.",
"deprecated": false
},
"entries": {
"name": "entries",
"args": [],
"class": {
"name": "ES6Iterator",
"description": ""
},
"description": "Returns an iterator containing all index/value pairs of this array.\n The iterator produces a series of two-element arrays with the first element as the index and the second element as the value.",
"deprecated": false
},
"every": {
"name": "every",
"args": [
{
"name": "callback",
"description": "the function to call to determine if every element in this array satisfies the test defined by the function. The callback function is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "boolean",
"description": "true if every element in this array satisfies the test performed in the callback function."
},
"description": "Returns true if every element in this array satisfies the test\n performed in the callback function. The callback function is\n invoked with three arguments: the value of the element,\n the index of the element, and the Array object being traversed.",
"deprecated": false
},
"every0": {
"name": "every",
"args": [
{
"name": "callback",
"description": "the function to call to determine if every element in this array satisfies the test defined by the function. The callback function is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "the Object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "boolean",
"description": "true if every element in thisObject satisfies the test performed in the callback function, false otherwise."
},
"description": "Returns true if every element in the thisObject argument satisfies the\n test performed in the callback function, false otherwise.\n The callback function is invoked with three arguments: the value of the\n element, the index of the element, and the Array object being traversed.",
"deprecated": false
},
"fill": {
"name": "fill",
"args": [
{
"name": "value",
"description": "The value to set.",
"class": {
"name": "Object"
},
"multiple": false
},
{
"name": "start",
"description": "Optional. The first index to copy. Default is 0.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "end",
"description": "Optional. The index of the end. This element is not included. Default is copy all to the array end.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "This array."
},
"description": "Sets multiple entries of this array to specific value.",
"deprecated": false
},
"filter": {
"name": "filter",
"args": [
{
"name": "callback",
"description": "the function that is called on this Array and which returns a new Array containing the elements that satisfy the function's test. The callback function is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a new Array containing the elements that satisfy the function's test."
},
"description": "Returns a new Array with all of the elements that pass the test\n implemented by the callback function. The callback function is\n invoked with three arguments: the value of the element,\n the index of the element, and the Array object being traversed.",
"deprecated": false
},
"filter0": {
"name": "filter",
"args": [
{
"name": "callback",
"description": "the function that is called on the thisObject Array and which returns a new Array containing the elements that satisfy the function's test. The callback function is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "the Object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a new Array containing the elements that satisfy the function's test."
},
"description": "Returns a new Array with all of the elements that pass the test\n implemented by the callback function that is run against the\n specified Array, thisObject. The callback function is\n invoked with three arguments: the value of the element,\n the index of the element, and the Array object being traversed.",
"deprecated": false
},
"find": {
"name": "find",
"args": [
{
"name": "callback",
"description": "The function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "The object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Object",
"description": "The first value within the array that satisfies the test defined in the callback function, undefined if no matching value was found."
},
"description": "Returns the first value within the array that satisfies the test\n defined in the callback function.",
"deprecated": false
},
"findIndex": {
"name": "findIndex",
"args": [
{
"name": "callback",
"description": "The function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "The object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Number",
"description": "The index of the first value within the array that satisfies the test defined in the callback function, -1 if no matching value was found."
},
"description": "Returns the index of the first value within the array that satisfies the test\n defined in the callback function.",
"deprecated": false
},
"forEach": {
"name": "forEach",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "void",
"description": ""
},
"description": "Runs the provided callback function once for each element present in\n the Array. The callback function is invoked only for indexes of the\n Array which have assigned values; it is not invoked for indexes which\n have been deleted or which have never been assigned a value.",
"deprecated": false
},
"forEach0": {
"name": "forEach",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "the Object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "void",
"description": ""
},
"description": "Runs the provided callback function once for each element present in\n the specified Array, thisObject. The callback function is invoked only\n for indexes of the Array which have assigned values; it is not invoked\n for indexes which have been deleted or which have never been assigned\n a value.",
"deprecated": false
},
"from": {
"name": "from",
"args": [
{
"name": "arrayLike",
"description": "An array-like object or an iterable that provides the elements for the new array.",
"class": {
"name": "Object"
},
"multiple": false
},
{
"name": "mapFn",
"description": "Optional. A function that maps the input elements into the value for the new array.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "Optional. The Object to use as 'this' when executing mapFn.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"static": true,
"class": {
"name": "Array",
"description": "The newly created array."
},
"description": "Creates a new array from an array-like object or an Iterable.",
"deprecated": false
},
"includes": {
"name": "includes",
"args": [
{
"name": "valueToFind",
"description": "The value to look for.",
"class": {
"name": "Object"
},
"multiple": false
},
{
"name": "fromIndex",
"description": "Optional. The index to start from.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "boolean",
"description": "true if the value is found in the array else false."
},
"description": "Returns if the array contains a specific value.",
"deprecated": false
},
"indexOf": {
"name": "indexOf",
"args": [
{
"name": "elementToLocate",
"description": "the element to locate in the Array.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Number",
"description": "the index of the element or -1 if it is no preset."
},
"description": "Returns the first index at which a given element can be found in the\n array, or -1 if it is not present.",
"deprecated": false
},
"indexOf0": {
"name": "indexOf",
"args": [
{
"name": "elementToLocate",
"description": "the element to locate in the Array.",
"class": {
"name": "Object"
},
"multiple": false
},
{
"name": "fromIndex",
"description": "the index from which to start looking for the element.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "Number",
"description": "the index of the element or -1 if it is no preset."
},
"description": "Returns the first index at which a given element can be found in the\n array starting at fromIndex, or -1 if it is not present.",
"deprecated": false
},
"isArray": {
"name": "isArray",
"args": [
{
"name": "object",
"description": "The object to ckeck.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"static": true,
"class": {
"name": "boolean",
"description": "true if the passed object is an array else false."
},
"description": "Checks if the passed object is an array.",
"deprecated": false
},
"join": {
"name": "join",
"args": [],
"class": {
"name": "String",
"description": "a concatenated list of all Array elements as a String."
},
"description": "Converts all Array elements to Strings and concatenates them.",
"deprecated": false
},
"join0": {
"name": "join",
"args": [
{
"name": "separator",
"description": "an optional character or string used to separate one element of the Array from the next element in the return String.",
"class": {
"name": "String"
},
"multiple": false
}
],
"class": {
"name": "String",
"description": "a concatenated list of all Array elements as a String where the specified delimiter is used to separate elements."
},
"description": "Converts all array elements to Strings and concatenates them.",
"deprecated": false
},
"keys": {
"name": "keys",
"args": [],
"class": {
"name": "ES6Iterator",
"description": ""
},
"description": "Returns an iterator containing all indexes of this array.",
"deprecated": false
},
"lastIndexOf": {
"name": "lastIndexOf",
"args": [
{
"name": "elementToLocate",
"description": "the element to locate in the Array.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Number",
"description": "the index of the element or -1 if it is no preset."
},
"description": "Returns the last index at which a given element can be found in the\n array, or -1 if it is not present. The array is searched backwards.",
"deprecated": false
},
"lastIndexOf0": {
"name": "lastIndexOf",
"args": [
{
"name": "elementToLocate",
"description": "the element to locate in the Array.",
"class": {
"name": "Object"
},
"multiple": false
},
{
"name": "fromIndex",
"description": "the index from which to start looking for the element. The array is searched backwards.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "Number",
"description": "the index of the element or -1 if it is no present."
},
"description": "Returns the last index at which a given element can be found in the\n array starting at fromIndex, or -1 if it is not present.\n The array is searched backwards.",
"deprecated": false
},
"map": {
"name": "map",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a new Array with the results of calling the specified function on every element in this Array."
},
"description": "Creates a new Array with the results of calling the specified function\n on every element in this Array. The callback function is invoked only\n for indexes of the Array which have assigned values; it is not invoked\n for indexes which have been deleted or which have never been assigned\n values.",
"deprecated": false
},
"map0": {
"name": "map",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "the Object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a new Array with the results of calling the specified function on every element in this Array."
},
"description": "Creates a new Array with the results of calling the specified function\n on every element in the specified Array. The callback function is invoked only\n for indexes of the Array which have assigned values; it is not invoked\n for indexes which have been deleted or which have never been assigned\n values.",
"deprecated": false
},
"of": {
"name": "of",
"args": [
{
"name": "values",
"description": "The array values.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"static": true,
"class": {
"name": "Array",
"description": "The newly created array."
},
"description": "Creates a new array from a variable list of elements.",
"deprecated": false
},
"pop": {
"name": "pop",
"args": [],
"class": {
"name": "Object",
"description": "the last element of the Array."
},
"description": "Removes and returns the last element of the Array.",
"deprecated": false
},
"push": {
"name": "push",
"args": [
{
"name": "values",
"description": "one or more values that will be appended to the Array.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"class": {
"name": "Number",
"description": "the new length of the Array."
},
"description": "Appends elements to the Array.",
"deprecated": false
},
"reverse": {
"name": "reverse",
"args": [],
"class": {
"name": "void",
"description": ""
},
"description": "Reverses the order of the elements in the Array.",
"deprecated": false
},
"shift": {
"name": "shift",
"args": [],
"class": {
"name": "Object",
"description": "the former first element."
},
"description": "Shifts elements down in the Array and returns the\n former first element.",
"deprecated": false
},
"slice": {
"name": "slice",
"args": [
{
"name": "start",
"description": "the location in the Array to start the slice operation.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "end",
"description": "the location in the Array to stop the slice operation.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a new Array containing the members bound by start and end."
},
"description": "Returns a new Array containing a portion of the\n Array using the specified start and end positions.",
"deprecated": false
},
"some": {
"name": "some",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "boolean",
"description": "true if any of the elements in the Array pass the test defined in the callback function, false otherwise."
},
"description": "Returns true if any of the elements in the Array pass the test\n defined in the callback function, false otherwise.",
"deprecated": false
},
"some0": {
"name": "some",
"args": [
{
"name": "callback",
"description": "the function to call, which is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.",
"class": {
"name": "Function"
},
"multiple": false
},
{
"name": "thisObject",
"description": "the Object to use as 'this' when executing callback.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"class": {
"name": "boolean",
"description": "true if any of the elements in the Array pass the test defined in the callback function, false otherwise."
},
"description": "Returns true if any of the elements in the specified Array pass the test\n defined in the callback function, false otherwise.",
"deprecated": false
},
"sort": {
"name": "sort",
"args": [],
"class": {
"name": "Array",
"description": "a reference to the Array."
},
"description": "Sorts the elements of the Array in alphabetical\n order based on character encoding.\n\n This sort is not guaranteed to be stable: equal elements might\n be reordered as a result of the sort.",
"deprecated": false
},
"sort0": {
"name": "sort",
"args": [
{
"name": "function",
"description": "a Function used to specify the sorting order.",
"class": {
"name": "Function"
},
"multiple": false
}
],
"class": {
"name": "Array",
"description": "a reference to the Array."
},
"description": "Sorts the elements of the Array in alphabetical\n order based on character encoding.\n\n This sort is not guaranteed to be stable: equal elements might\n be reordered as a result of the sort.",
"deprecated": false
},
"splice": {
"name": "splice",
"args": [
{
"name": "start",
"description": "the start location.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "deleteCount",
"description": "the number of items to delete.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "values",
"description": "zero or more values to be inserted into the Array.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"class": {
"name": "Array",
"description": ""
},
"description": "Deletes the specified number of elements from the Array at the specified position,\n and then inserts values into the Array at that location.",
"deprecated": false
},
"toLocaleString0": {
"name": "toLocaleString",
"args": [],
"class": {
"name": "String",
"description": "a localized String representing the Array."
},
"description": "Converts the Array to a localized String.",
"deprecated": false
},
"toString0": {
"name": "toString",
"args": [],
"class": {
"name": "String",
"description": "a String representation of the Array."
},
"description": "Converts the Array to a String.",
"deprecated": false
},
"unshift": {
"name": "unshift",
"args": [
{
"name": "values",
"description": "one or more vales that will be inserted into the beginning of the Array.",
"class": {
"name": "Object"
},
"multiple": true
}
],
"class": {
"name": "Number",
"description": "the new length of the Array."
},
"description": "Inserts elements at the beginning of the Array.",
"deprecated": false
},
"values": {
"name": "values",
"args": [],
"class": {
"name": "ES6Iterator",
"description": ""
},
"description": "Returns an iterator containing all values of this array.",
"deprecated": false
}
}
},
"ArrayBuffer": {
"fullClassName": "TopLevel.ArrayBuffer",
"package": "TopLevel",
"description": "The ArrayBuffer represents a generic array of bytes with fixed length. <br>\n To access and manipulate content, use <a href=\"class_TopLevel_DataView.html\">DataView</a> or a typed array.",
"hierarchy": [
{
"name": "Object"
}
],
"constants": {},
"properties": {
"byteLength": {
"name": "byteLength",
"class": {
"name": "Number"
},
"static": false,
"readonly": false,
"description": "The number of bytes in the array buffer.",
"deprecated": false,
"type": "property"
}
},
"constructors": {
"ArrayBuffer": {
"name": "ArrayBuffer",
"args": [],
"class": {
"description": ""
},
"description": "Creates an empty array buffer.",
"deprecated": false
},
"ArrayBuffer0": {
"name": "ArrayBuffer",
"args": [
{
"name": "byteLength",
"description": "The number of bytes.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Creates an array buffer with the given number of bytes.",
"deprecated": false
}
},
"methods": {
"isView": {
"name": "isView",
"args": [
{
"name": "object",
"description": "The object to check.",
"class": {
"name": "Object"
},
"multiple": false
}
],
"static": true,
"class": {
"name": "boolean",
"description": "true if the passed object is a view to an array buffer else return false."
},
"description": "Returns if the given object is one of the views for an ArrayBuffer, such as a typed array or a DataView.",
"deprecated": false
},
"slice": {
"name": "slice",
"args": [
{
"name": "begin",
"description": "Optional. The first included element.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "end",
"description": "Optional. The index of the end. This element is not included.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "ArrayBuffer",
"description": "The new array object."
},
"description": "Returns a new array buffer with a copy of the data of this buffer.",
"deprecated": false
}
}
},
"BigInt": {
"fullClassName": "TopLevel.BigInt",
"package": "TopLevel",
"description": "A BigInt object is a wrapper for a primitive <code>bigint</code> value.\n <code>bigint</code> values can be numbers too large to be stored as <code>number</code> values.\n <p>\n A <code>bigint</code> literal in code is an integer number with an appended <code>n</code>.\n </p><p>\n Example:\n <code></code></p><pre><code> var hugeNumber = 1245678901234567890n;\n var hugeNumberObject = BigInt( hugeNumber );\n </code></pre>",
"hierarchy": [
{
"name": "Object"
}
],
"constants": {},
"properties": {},
"constructors": {
"BigInt": {
"name": "BigInt",
"args": [],
"class": {
"description": ""
},
"description": "Constructs a BigInt with value 0.",
"deprecated": false
},
"BigInt0": {
"name": "BigInt",
"args": [
{
"name": "value",
"description": "the BigInt to use.",
"class": {
"name": "BigInt"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Constructs a new BigInt using the specified BigInt.",
"deprecated": false
},
"BigInt01": {
"name": "BigInt",
"args": [
{
"name": "value",
"description": "the value to use when creating the BigInt.",
"class": {
"name": "String"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Constructs a BigInt using the specified value.\n \n Beside decimal numbers also binary, octal and hexadecimal numbers are supported: var decimal = BigInt( \"12\" );\n var binary = BigInt( \"0b1100\" );\n var octal = BigInt( \"0o14\" );\n var hex = BigInt( \"0xC\" );",
"deprecated": false
}
},
"methods": {
"asIntN": {
"name": "asIntN",
"args": [
{
"name": "bits",
"description": "Number of bits required for resulting integer.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "value",
"description": "The value to be clamped to the given number of bits.",
"class": {
"name": "BigInt"
},
"multiple": false
}
],
"static": true,
"class": {
"name": "BigInt",
"description": "The value modulo 2bits, as a signed integer."
},
"description": "Clamps the given BigInt value to a signed integer with a given precision.",
"deprecated": false
},
"asUintN": {
"name": "asUintN",
"args": [
{
"name": "bits",
"description": "Number of bits required for resulting integer.",
"class": {
"name": "Number"
},
"multiple": false
},
{
"name": "value",
"description": "The value to be clamped to the given number of bits.",
"class": {
"name": "BigInt"
},
"multiple": false
}
],
"static": true,
"class": {
"name": "BigInt",
"description": "The value modulo 2bits, as an unsigned integer."
},
"description": "Clamps the given BigInt value to an unsigned integer with a given precision.",
"deprecated": false
},
"toLocaleString0": {
"name": "toLocaleString",
"args": [],
"class": {
"name": "String",
"description": "a String using local number formatting conventions."
},
"description": "Converts this BigInt to a String using local number formatting conventions. \n The current implementation actually only returns the same as toString().",
"deprecated": false
},
"toString0": {
"name": "toString",
"args": [],
"class": {
"name": "String",
"description": "a String representation of this BigInt."
},
"description": "A String representation of this BigInt.",
"deprecated": false
},
"toString01": {
"name": "toString",
"args": [
{
"name": "radix",
"description": "the radix to use.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"name": "String",
"description": "a String representation of this BigInt."
},
"description": "Converts the BigInt into a string using the specified radix (base).",
"deprecated": false
}
}
},
"Boolean": {
"fullClassName": "TopLevel.Boolean",
"package": "TopLevel",
"description": "Provides support for boolean values.",
"hierarchy": [
{
"name": "Object"
}
],
"constants": {},
"properties": {},
"constructors": {
"Boolean": {
"name": "Boolean",
"args": [
{
"name": "value",
"description": "the String value to use to construct the Boolean. If value is null or an empty String, the Boolean is set to false.",
"class": {
"name": "String"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Constructs the Boolean using the specified \n String value.",
"deprecated": false
},
"Boolean0": {
"name": "Boolean",
"args": [
{
"name": "value",
"description": "the Number value to use to construct the Boolean. If value is null or 0, the Boolean is set to false.",
"class": {
"name": "Number"
},
"multiple": false
}
],
"class": {
"description": ""
},
"description": "Constructs the Boolean using the specified \n Number value.",
"deprecated": false
}
},
"methods": {
"toString0": {
"name": "toString",
"args": [],
"class": {
"name": "String",
"description": "true or false depending on the value used to create the Boolean."
},
"description": "Returns true or false depending on the value used to create \n the Boolean.",
"deprecated": false
},
"valueOf0": {
"name": "valueOf",
"args": [],
"class": {
"name": "Object",
"description": "the primitive boolean contained in the Boolean object."
},
"description": "Returns the primitive boolean contained in the Boolean \n object.",
"deprecated": false
}
}
},
"ConversionError": {
"fullClassName": "TopLevel.ConversionError",
"package": "TopLevel",
"description": "Represents a conversion error.",
"hierarchy": [
{
"name": "Object"
},
{
"name": "TopLevel.Error"
}
],
"constants": {},
"properties": {},
"constructors": {
"ConversionError": {
"name": "ConversionError",
"args": [],
"class": {
"description": ""
},
"description": "Constructs the error.",
"deprecated": false
},
"ConversionError0": {
"name": "ConversionError",
"args": [
{
"name": "msg",
"description": "the conversion error message.",
"class"