|
|
|
@ -5,32 +5,35 @@
|
|
|
|
|
"AcceleratorRange.TwoG": "The accelerator measures forces up to 2 gravity",
|
|
|
|
|
"Array": "Add, remove, and replace items in lists.\n\nAdd, remove, and replace items in lists.",
|
|
|
|
|
"Array.every": "Tests whether all elements in the array pass the test implemented by the provided function.",
|
|
|
|
|
"Array.every|param|callbackfn": "A function that accepts up to two arguments. The every method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.every|param|callbackfn": "A function that accepts up to two arguments. The some method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.filter": "Return the elements of an array that meet the condition specified in a callback function.",
|
|
|
|
|
"Array.filter|param|callbackfn": "A function that accepts up to two arguments. The filter method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.forEach": "Call a defined callback function on each element of an array.",
|
|
|
|
|
"Array.forEach|param|callbackfn": "A function that accepts up to two arguments. The forEach method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.get": "Get the value at a particular index",
|
|
|
|
|
"Array.get": "Get the value at a particular index.",
|
|
|
|
|
"Array.get|param|index": "the zero-based position in the list of the item, eg: 0",
|
|
|
|
|
"Array.indexOf": "Return the index of the first occurrence of a value in an array.",
|
|
|
|
|
"Array.indexOf|param|fromIndex": "The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.",
|
|
|
|
|
"Array.indexOf|param|item": "The value to locate in the array.",
|
|
|
|
|
"Array.insertAt": "Insert the value at a particular index, increases length by 1",
|
|
|
|
|
"Array.insertAt": "Insert the value at a particular index, increase the array length by 1.",
|
|
|
|
|
"Array.insertAt|param|index": "the zero-based position in the list to insert the value, eg: 0",
|
|
|
|
|
"Array.insertAt|param|value": "to insert, eg: 0",
|
|
|
|
|
"Array.join": "joins all elements of an array into a string and returns this string.",
|
|
|
|
|
"Array.join|param|sep": "the string separator",
|
|
|
|
|
"Array.length": "Get or set the length of an array. This number is one more than the index of the last element the array.",
|
|
|
|
|
"Array.length": "Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.",
|
|
|
|
|
"Array.map": "Call a defined callback function on each element of an array, and return an array containing the results.",
|
|
|
|
|
"Array.map|param|callbackfn": "A function that accepts up to two arguments. The map method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.pop": "Remove the last element from an array and return it.",
|
|
|
|
|
"Array.push": "Append a new element to an array.",
|
|
|
|
|
"Array.push": "Append a new elements to an array.",
|
|
|
|
|
"Array.push|param|item": "to append to the Array.",
|
|
|
|
|
"Array.reduce": "Call the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
|
|
|
|
|
"Array.reduce|param|callbackfn": "A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the array.",
|
|
|
|
|
"Array.reduce|param|initialValue": "Initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.",
|
|
|
|
|
"Array.removeAt": "Remove the element at a certain index.",
|
|
|
|
|
"Array.removeElement": "Remove the first occurence of an object. Returns true if removed.",
|
|
|
|
|
"Array.removeAt|param|index": "the zero-based position in the list to remove the value from, eg: 0",
|
|
|
|
|
"Array.removeElement": "Remove the first occurence of an object. Return true if removed.",
|
|
|
|
|
"Array.reverse": "Reverse the elements in an array. The first array element becomes the last, and the last array element becomes the first.",
|
|
|
|
|
"Array.set": "Store a value at a particular index",
|
|
|
|
|
"Array.set": "Store a value at a particular index.",
|
|
|
|
|
"Array.set|param|index": "the zero-based position in the list to store the value, eg: 0",
|
|
|
|
|
"Array.shift": "Remove the first element from an array and return it. This method changes the length of the array.",
|
|
|
|
|
"Array.slice": "Return a section of an array.",
|
|
|
|
@ -43,6 +46,7 @@
|
|
|
|
|
"Array.splice|param|deleteCount": "The number of elements to remove. eg: 0",
|
|
|
|
|
"Array.splice|param|start": "The zero-based location in the array from which to start removing elements. eg: 0",
|
|
|
|
|
"Array.unshift": "Add one element to the beginning of an array and return the new length of the array.",
|
|
|
|
|
"Array.unshift|param|value": "to insert at the start of the Array.",
|
|
|
|
|
"Boolean.toString": "Returns a string representation of an object.",
|
|
|
|
|
"Buffer.fill": "Fill (a fragment) of the buffer with given value.",
|
|
|
|
|
"Buffer.getNumber": "Read a number in specified format from the buffer.",
|
|
|
|
@ -97,21 +101,8 @@
|
|
|
|
|
"Math": "More complex operations with numbers.",
|
|
|
|
|
"Math.abs": "Returns the absolute value of a number (the value without regard to whether it is positive or negative).\nFor example, the absolute value of -5 is the same as the absolute value of 5.",
|
|
|
|
|
"Math.abs|param|x": "A numeric expression for which the absolute value is needed.",
|
|
|
|
|
"Math.acos": "Returns the arccosine (in radians) of a number",
|
|
|
|
|
"Math.acos|param|x": "A number",
|
|
|
|
|
"Math.asin": "Returns the arcsine (in radians) of a number",
|
|
|
|
|
"Math.asin|param|x": "A number",
|
|
|
|
|
"Math.atan": "Returns the arctangent (in radians) of a number",
|
|
|
|
|
"Math.atan2": "Returns the arctangent of the quotient of its arguments.",
|
|
|
|
|
"Math.atan2|param|x": "A number",
|
|
|
|
|
"Math.atan2|param|y": "A number",
|
|
|
|
|
"Math.atan|param|x": "A number",
|
|
|
|
|
"Math.ceil": "Returns the smallest number greater than or equal to its numeric argument.",
|
|
|
|
|
"Math.ceil|param|x": "A numeric expression.",
|
|
|
|
|
"Math.cos": "Returns the cosine of a number.",
|
|
|
|
|
"Math.cos|param|x": "An angle in radians",
|
|
|
|
|
"Math.exp": "Returns returns ``e^x``.",
|
|
|
|
|
"Math.exp|param|x": "A number",
|
|
|
|
|
"Math.floor": "Returns the greatest number less than or equal to its numeric argument.",
|
|
|
|
|
"Math.floor|param|x": "A numeric expression.",
|
|
|
|
|
"Math.idiv": "Returns the value of integer signed 32 bit division of two numbers.",
|
|
|
|
@ -120,45 +111,37 @@
|
|
|
|
|
"Math.imul": "Returns the value of integer signed 32 bit multiplication of two numbers.",
|
|
|
|
|
"Math.imul|param|x": "The first number",
|
|
|
|
|
"Math.imul|param|y": "The second number",
|
|
|
|
|
"Math.log": "Returns the natural logarithm (base e) of a number.",
|
|
|
|
|
"Math.log|param|x": "A number",
|
|
|
|
|
"Math.max": "Returns the larger of two supplied numeric expressions.",
|
|
|
|
|
"Math.min": "Returns the smaller of two supplied numeric expressions.",
|
|
|
|
|
"Math.pow": "Returns the value of a base expression taken to a specified power.",
|
|
|
|
|
"Math.pow": "Return the value of a base expression taken to a specified power.",
|
|
|
|
|
"Math.pow|param|x": "The base value of the expression.",
|
|
|
|
|
"Math.pow|param|y": "The exponent value of the expression.",
|
|
|
|
|
"Math.random": "Returns a pseudorandom number between 0 and 1.",
|
|
|
|
|
"Math.random": "Return a pseudorandom number between 0 and `limit`.",
|
|
|
|
|
"Math.randomBoolean": "Generates a `true` or `false` value randomly, just like flipping a coin.",
|
|
|
|
|
"Math.randomRange": "Returns a pseudorandom number between min and max included.\nIf both numbers are integral, the result is integral.",
|
|
|
|
|
"Math.randomRange|param|max": "the upper inclusive bound, eg: 10",
|
|
|
|
|
"Math.randomRange|param|min": "the lower inclusive bound, eg: 0",
|
|
|
|
|
"Math.random|param|limit": "the upper bound of the number generated, eg: 4",
|
|
|
|
|
"Math.round": "Returns a supplied numeric expression rounded to the nearest number.",
|
|
|
|
|
"Math.round|param|x": "The value to be rounded to the nearest number.",
|
|
|
|
|
"Math.sign": "Returns the sign of the x, indicating whether x is positive, negative or zero.",
|
|
|
|
|
"Math.sign|param|x": "The numeric expression to test",
|
|
|
|
|
"Math.sin": "Returns the sine of a number.",
|
|
|
|
|
"Math.sin|param|x": "An angle in radians",
|
|
|
|
|
"Math.sqrt": "Returns the square root of a number.",
|
|
|
|
|
"Math.sqrt": "Return the square root of a number.",
|
|
|
|
|
"Math.sqrt|param|x": "A numeric expression.",
|
|
|
|
|
"Math.tan": "Returns the tangent of a number.",
|
|
|
|
|
"Math.tan|param|x": "An angle in radians",
|
|
|
|
|
"Math.trunc": "Returns the number with the decimal part truncated.",
|
|
|
|
|
"Math.trunc|param|x": "A numeric expression.",
|
|
|
|
|
"Number.toString": "Returns a string representation of a number.",
|
|
|
|
|
"Number.toString": "Return a string representation of a number.",
|
|
|
|
|
"String": "Combine, split, and search text strings.\n\nCombine, split, and search text strings.",
|
|
|
|
|
"String.charAt": "Return the character at the specified index.",
|
|
|
|
|
"String.charAt|param|index": "The zero-based index of the desired character.",
|
|
|
|
|
"String.charAt|param|index": "The zero-based index of the desired character, eg: 0",
|
|
|
|
|
"String.charCodeAt": "Return the Unicode value of the character at the specified location.",
|
|
|
|
|
"String.charCodeAt|param|index": "The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.",
|
|
|
|
|
"String.compare": "See how the order of characters in two strings is different (in ASCII encoding).",
|
|
|
|
|
"String.compare|param|that": "String to compare to target string",
|
|
|
|
|
"String.concat": "Returns a string that contains the concatenation of two or more strings.",
|
|
|
|
|
"String.concat|param|other": "The string to append to the end of the string.",
|
|
|
|
|
"String.concat|param|other": "The string to append to the end of the string, eg: \"add me!\"",
|
|
|
|
|
"String.fromCharCode": "Make a string from the given ASCII character code.",
|
|
|
|
|
"String.isEmpty": "Returns a value indicating if the string is empty",
|
|
|
|
|
"String.length": "Returns the length of a String object.",
|
|
|
|
|
"String.length": "Return the length of a String object.",
|
|
|
|
|
"String.substr": "Return a substring of the current string.",
|
|
|
|
|
"String.substr|param|length": "number of characters to extract",
|
|
|
|
|
"String.substr|param|length": "number of characters to extract, eg: 3",
|
|
|
|
|
"String.substr|param|start": "first character index; can be negative from counting from the end, eg: 0",
|
|
|
|
|
"basic": "Provides access to basic micro:bit functionality.",
|
|
|
|
|
"basic.clearScreen": "Turn off all LEDs",
|
|
|
|
@ -368,7 +351,7 @@
|
|
|
|
|
"music": "Generation of music tones.",
|
|
|
|
|
"music.beat": "Returns the duration of a beat in milli-seconds",
|
|
|
|
|
"music.beginMelody": "Starts playing a melody.\nNotes are expressed as a string of characters with this format: NOTE[octave][:duration]",
|
|
|
|
|
"music.beginMelody|param|melodyArray": "the melody array to play, eg: Melodies.Dadadadum",
|
|
|
|
|
"music.beginMelody|param|melodyArray": "the melody array to play, eg: ['g5:1']",
|
|
|
|
|
"music.beginMelody|param|options": "melody options, once / forever, in the foreground / background",
|
|
|
|
|
"music.builtInMelody": "Gets the melody array of a built-in melody.",
|
|
|
|
|
"music.changeTempoBy": "Change the tempo by the specified amount",
|
|
|
|
@ -377,12 +360,12 @@
|
|
|
|
|
"music.noteFrequency|param|name": "the note name, eg: Note.C",
|
|
|
|
|
"music.onEvent": "Registers code to run on various melody events",
|
|
|
|
|
"music.playTone": "Plays a tone through pin ``P0`` for the given duration.",
|
|
|
|
|
"music.playTone|param|frequency": "pitch of the tone to play in Hertz (Hz), eg: Note.C",
|
|
|
|
|
"music.playTone|param|frequency": "pitch of the tone to play in Hertz (Hz)",
|
|
|
|
|
"music.playTone|param|ms": "tone duration in milliseconds (ms)",
|
|
|
|
|
"music.rest": "Rests (plays nothing) for a specified time through pin ``P0``.",
|
|
|
|
|
"music.rest|param|ms": "rest duration in milliseconds (ms)",
|
|
|
|
|
"music.ringTone": "Plays a tone through pin ``P0``.",
|
|
|
|
|
"music.ringTone|param|frequency": "pitch of the tone to play in Hertz (Hz), eg: Note.C",
|
|
|
|
|
"music.ringTone|param|frequency": "pitch of the tone to play in Hertz (Hz)",
|
|
|
|
|
"music.setPlayTone": "Sets a custom playTone function for playing melodies",
|
|
|
|
|
"music.setTempo": "Sets the tempo to the specified amount",
|
|
|
|
|
"music.setTempo|param|bpm": "The new tempo in beats per minute, eg: 120",
|
|
|
|
|