diff --git a/typescript/types/main.d.ts b/typescript/types/main.d.ts index a9671e400..3e14741ee 100644 --- a/typescript/types/main.d.ts +++ b/typescript/types/main.d.ts @@ -50,11 +50,13 @@ type MenuOptions = { * Object containing data about a menu to pass to `E.showMenu`. */ type Menu = { + ""?: MenuOptions; [key: string]: | MenuOptions | (() => void) | MenuBooleanItem | MenuNumberItem + | { value: string; onchange?: () => void } | undefined; }; @@ -67,6 +69,58 @@ type MenuInstance = { select: () => void; }; +type ImageObject = { + width: number; + height: number; + bpp?: number; + buffer: ArrayBuffer | string; + transparent?: number; + palette?: Uint16Array; +}; + +type Image = string | ImageObject | ArrayBuffer | Graphics; + +type ColorResolvable = number | `#${string}`; + +type FontName = + | "4x4" + | "4x4Numeric" + | "4x5" + | "4x5Numeric" + | "4x8Numeric" + | "5x7Numeric7Seg" + | "5x9Numeric7Seg" + | "6x8" + | "6x12" + | "7x11Numeric7Seg" + | "8x12" + | "8x16" + | "Dennis8" + | "Cherry6x10" + | "Copasectic40x58Numeric" + | "Dylex7x13" + | "HaxorNarrow7x17" + | "Sinclair" + | "Teletext10x18Mode7" + | "Teletext5x9Ascii" + | "Teletext5x9Mode7" + | "Vector"; + +type FontNameWithScaleFactor = + | FontName + | `${FontName}:${number}` + | `${FontName}:${number}x${number}`; + +type Theme = { + fg: number; + bg: number; + fg2: number; + bg2: number; + fgH: number; + bgH: number; + dark: boolean; +}; + type NRFFilters = { services?: string[]; name?: string; @@ -76,7 +130,13 @@ type NRFFilters = { manufacturerData?: object; }; -declare const g: Graphics; +declare const BTN1: Pin; +declare const BTN2: Pin; +declare const BTN3: Pin; +declare const BTN4: Pin; +declare const BTN5: Pin; + +declare const g: Graphics; type WidgetArea = "tl" | "tr" | "bl" | "br"; type Widget = { @@ -86,11 +146,139 @@ type Widget = { }; declare const WIDGETS: { [key: string]: Widget }; +type AccelData = { + x: number; + y: number; + z: number; + diff: number; + mag: number; +}; + +type HealthStatus = { + movement: number; + steps: number; + bpm: number; + bpmConfidence: number; +}; + +type CompassData = { + x: number; + y: number; + z: number; + dx: number; + dy: number; + dz: number; + heading: number; +}; + +type GPSFix = { + lat: number; + lon: number; + alt: number; + speed: number; + course: number; + time: Date; + satellites: number; + fix: number; + hdop: number +}; + +type PressureData = { + temperature: number; + pressure: number; + altitude: number; +} + +type TapAxis = -2 | -1 | 0 | 1 | 2; + +type SwipeCallback = (directionLR: -1 | 0 | 1, directionUD?: -1 | 0 | 1) => void; + +type TouchCallback = (button: number, xy?: { x: number, y: number }) => void; + +type DragCallback = (event: { + x: number; + y: number; + dx: number; + dy: number; + b: 1 | 0; +}) => void; + +type LCDMode = + | "direct" + | "doublebuffered" + | "120x120" + | "80x80" + +type BangleOptions = { + wakeOnBTN1: boolean; + wakeOnBTN2: boolean; + wakeOnBTN3: boolean; + wakeOnFaceUp: boolean; + wakeOnTouch: boolean; + wakeOnTwist: boolean; + twistThreshold: number; + twistMaxY: number; + twistTimeout: number; + gestureStartThresh: number; + gestureEndThresh: number; + gestureInactiveCount: number; + gestureMinLength: number; + powerSave: boolean; + lockTimeout: number; + lcdPowerTimeout: number; + backlightTimeout: number; +}; + +interface ArrayLike { + readonly length: number; + readonly [n: number]: T; +} + +type PinMode = + | "analog" + | "input" + | "input_pullup" + | "input_pulldown" + | "output" + | "opendrain" + | "af_output" + | "af_opendrain"; + +type ErrorFlag = + | "FIFO_FULL" + | "BUFFER_FULL" + | "CALLBACK" + | "LOW_MEMORY" + | "MEMORY" + | "UART_OVERFLOW"; + +type Flag = + | "deepSleep" + | "pretokenise" + | "unsafeFlash" + | "unsyncFiles"; + +type Uint8ArrayResolvable = + | number + | string + | Uint8ArrayResolvable[] + | ArrayBuffer + | ArrayBufferView + | { data: Uint8ArrayResolvable, count: number } + | { callback: () => Uint8ArrayResolvable } + +type VariableSizeInformation = { + name: string; + size: number; + more?: VariableSizeInformation; +}; + // CLASSES /** - * Class containing [micro:bit's](https://www.espruino.com/MicroBit) utility functions. + * Class containing [micro:bit's](https://www.espruino.com/MicroBit) utility + * functions. * @url http://www.espruino.com/Reference#Microbit */ declare class Microbit { @@ -117,7 +305,8 @@ declare class Microbit { static MIC_ENABLE: Pin; /** - * Called when the Micro:bit is moved in a deliberate fashion, and includes data on the detected gesture. + * Called when the Micro:bit is moved in a deliberate fashion, and includes data on + * the detected gesture. * @param {string} event - The event to listen to. * @param {(gesture: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `gesture` An Int8Array containing the accelerations (X,Y,Z) from the last gesture detected by the accelerometer @@ -138,28 +327,30 @@ declare class Microbit { static accel(): any; /** - * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) board + * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) + * board * Write the given value to the accelerometer * * @param {number} addr - Accelerometer address * @param {number} data - Data to write * @url http://www.espruino.com/Reference#l_Microbit_accelWr */ - static accelWr(addr: number, data: number): any; + static accelWr(addr: number, data: number): void; /** - * Turn on the accelerometer, and create `Microbit.accel` and `Microbit.gesture` events. - * **Note:** The accelerometer is currently always enabled - this code - * just responds to interrupts and reads + * Turn on the accelerometer, and create `Microbit.accel` and `Microbit.gesture` + * events. + * **Note:** The accelerometer is currently always enabled - this code just + * responds to interrupts and reads * @url http://www.espruino.com/Reference#l_Microbit_accelOn */ - static accelOn(): any; + static accelOn(): void; /** * Turn off events from the accelerometer (started with `Microbit.accelOn`) * @url http://www.espruino.com/Reference#l_Microbit_accelOff */ - static accelOff(): any; + static accelOff(): void; /** * Play a waveform on the Micro:bit's speaker @@ -169,7 +360,7 @@ declare class Microbit { * @param {any} callback - A function to call when playback is finished * @url http://www.espruino.com/Reference#l_Microbit_play */ - static play(waveform: any, samplesPerSecond: any, callback: any): any; + static play(waveform: any, samplesPerSecond: any, callback: any): void; /** * Records sound from the micro:bit's onboard microphone and returns the result @@ -179,7 +370,7 @@ declare class Microbit { * @param {any} [samples] - [optional] How many samples to record (6000 default) * @url http://www.espruino.com/Reference#l_Microbit_record */ - static record(samplesPerSecond: any, callback: any, samples?: any): any; + static record(samplesPerSecond: any, callback: any, samples?: any): void; } @@ -362,7 +553,8 @@ interface MathConstructor { log(x: number): number; /** - * DEPRECATED - Please use `E.clip()` instead. Clip a number to be between min and max (inclusive) + * DEPRECATED - Please use `E.clip()` instead. Clip a number to be between min and + * max (inclusive) * * @param {number} x - A floating point value to clip * @param {number} min - The smallest the value should be @@ -374,7 +566,8 @@ interface MathConstructor { /** * DEPRECATED - This is not part of standard JavaScript libraries - * Wrap a number around if it is less than 0 or greater than or equal to max. For instance you might do: ```Math.wrap(angleInDegrees, 360)``` + * Wrap a number around if it is less than 0 or greater than or equal to max. For + * instance you might do: ```Math.wrap(angleInDegrees, 360)``` * * @param {number} x - A floating point value to wrap * @param {number} max - The largest the value should be @@ -434,7 +627,7 @@ declare class TFMicroInterpreter { /** * @url http://www.espruino.com/Reference#l_TFMicroInterpreter_invoke */ - invoke(): any; + invoke(): void; } /** @@ -444,7 +637,8 @@ declare class TFMicroInterpreter { declare class Badge { /** * Capacitive sense - the higher the capacitance, the higher the number returned. - * Supply a corner number between 1 and 6, and an integer value will be returned that is proportional to the capacitance + * Supply a corner number between 1 and 6, and an integer value will be returned + * that is proportional to the capacitance * * @param {number} corner - The corner to use * @returns {number} Capacitive sense counter @@ -453,8 +647,8 @@ declare class Badge { static capSense(corner: number): number; /** - * Return an approximate battery percentage remaining based on - * a normal CR2032 battery (2.8 - 2.2v) + * Return an approximate battery percentage remaining based on a normal CR2032 + * battery (2.8 - 2.2v) * @returns {number} A percentage between 0 and 100 * @url http://www.espruino.com/Reference#l_Badge_getBatteryPercentage */ @@ -466,7 +660,7 @@ declare class Badge { * @param {number} c - Contrast between 0 and 1 * @url http://www.espruino.com/Reference#l_Badge_setContrast */ - static setContrast(c: number): any; + static setContrast(c: number): void; } @@ -479,40 +673,43 @@ declare class Puck { /** * Turn on the magnetometer, take a single reading, and then turn it off again. * An object of the form `{x,y,z}` is returned containing magnetometer readings. - * Due to residual magnetism in the Puck and magnetometer itself, with - * no magnetic field the Puck will not return `{x:0,y:0,z:0}`. - * Instead, it's up to you to figure out what the 'zero value' is for your - * Puck in your location and to then subtract that from the value returned. If - * you're not trying to measure the Earth's magnetic field then it's a good idea - * to just take a reading at startup and use that. + * Due to residual magnetism in the Puck and magnetometer itself, with no magnetic + * field the Puck will not return `{x:0,y:0,z:0}`. + * Instead, it's up to you to figure out what the 'zero value' is for your Puck in + * your location and to then subtract that from the value returned. If you're not + * trying to measure the Earth's magnetic field then it's a good idea to just take + * a reading at startup and use that. * With the aerial at the top of the board, the `y` reading is vertical, `x` is * horizontal, and `z` is through the board. * Readings are in increments of 0.1 micro Tesla (uT). The Earth's magnetic field - * varies from around 25-60 uT, so the reading will vary by 250 to 600 depending - * on location. + * varies from around 25-60 uT, so the reading will vary by 250 to 600 depending on + * location. * @returns {any} An Object `{x,y,z}` of magnetometer readings as integers * @url http://www.espruino.com/Reference#l_Puck_mag */ static mag(): any; /** - * Turn on the magnetometer, take a single temperature reading from the MAG3110 chip, and then turn it off again. + * Turn on the magnetometer, take a single temperature reading from the MAG3110 + * chip, and then turn it off again. * (If the magnetometer is already on, this just returns the last reading obtained) - * `E.getTemperature()` uses the microcontroller's temperature sensor, but this uses the magnetometer's. - * The reading obtained is an integer (so no decimal places), but the sensitivity is factory trimmed. to 1°C, however the temperature - * offset isn't - so absolute readings may still need calibrating. + * `E.getTemperature()` uses the microcontroller's temperature sensor, but this + * uses the magnetometer's. + * The reading obtained is an integer (so no decimal places), but the sensitivity + * is factory trimmed. to 1°C, however the temperature offset isn't - so + * absolute readings may still need calibrating. * @returns {number} Temperature in degrees C * @url http://www.espruino.com/Reference#l_Puck_magTemp */ static magTemp(): number; /** - * Called after `Puck.magOn()` every time magnetometer data - * is sampled. There is one argument which is an object - * of the form `{x,y,z}` containing magnetometer readings - * as integers (for more information see `Puck.mag()`). - * Check out [the Puck.js page on the magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information. + * Called after `Puck.magOn()` every time magnetometer data is sampled. There is + * one argument which is an object of the form `{x,y,z}` containing magnetometer + * readings as integers (for more information see `Puck.mag()`). + * Check out [the Puck.js page on the + * magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Puck_mag @@ -521,12 +718,12 @@ declare class Puck { /** * Only on Puck.js v2.0 - * Called after `Puck.accelOn()` every time accelerometer data - * is sampled. There is one argument which is an object - * of the form `{acc:{x,y,z}, gyro:{x,y,z}}` containing the data. - * The data is as it comes off the accelerometer and is not - * scaled to 1g. For more information see `Puck.accel()` or - * [the Puck.js page on the magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals). + * Called after `Puck.accelOn()` every time accelerometer data is sampled. There is + * one argument which is an object of the form `{acc:{x,y,z}, gyro:{x,y,z}}` + * containing the data. + * The data is as it comes off the accelerometer and is not scaled to 1g. For more + * information see `Puck.accel()` or [the Puck.js page on the + * magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals). * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Puck_accel @@ -534,8 +731,8 @@ declare class Puck { static on(event: "accel", callback: () => void): void; /** - * Turn the magnetometer on and start periodic sampling. Samples will then cause - * a 'mag' event on 'Puck': + * Turn the magnetometer on and start periodic sampling. Samples will then cause a + * 'mag' event on 'Puck': * ``` * Puck.magOn(); * Puck.on('mag', function(xyz) { @@ -545,8 +742,9 @@ declare class Puck { * // Turn events off with Puck.magOff(); * ``` * This call will be ignored if the sampling is already on. - * If given an argument, the sample rate is set (if not, it's at 0.63 Hz). - * The sample rate must be one of the following (resulting in the given power consumption): + * If given an argument, the sample rate is set (if not, it's at 0.63 Hz). The + * sample rate must be one of the following (resulting in the given power + * consumption): * * 80 Hz - 900uA * * 40 Hz - 550uA * * 20 Hz - 275uA @@ -558,38 +756,43 @@ declare class Puck { * * 0.31 Hz - 8uA * * 0.16 Hz - 8uA * * 0.08 Hz - 8uA - * When the battery level drops too low while sampling is turned on, - * the magnetometer may stop sampling without warning, even while other - * Puck functions continue uninterrupted. - * Check out [the Puck.js page on the magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information. + * When the battery level drops too low while sampling is turned on, the + * magnetometer may stop sampling without warning, even while other Puck functions + * continue uninterrupted. + * Check out [the Puck.js page on the + * magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information. * * @param {number} samplerate - The sample rate in Hz, or undefined * @url http://www.espruino.com/Reference#l_Puck_magOn */ - static magOn(samplerate: number): any; + static magOn(samplerate: number): void; /** * Turn the magnetometer off * @url http://www.espruino.com/Reference#l_Puck_magOff */ - static magOff(): any; + static magOff(): void; /** - * Writes a register on the LIS3MDL / MAX3110 Magnetometer. Can be used for configuring advanced functions. - * Check out [the Puck.js page on the magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information and links to modules that use this function. + * Writes a register on the LIS3MDL / MAX3110 Magnetometer. Can be used for + * configuring advanced functions. + * Check out [the Puck.js page on the + * magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information and links to modules that use this function. * * @param {number} reg * @param {number} data * @url http://www.espruino.com/Reference#l_Puck_magWr */ - static magWr(reg: number, data: number): any; + static magWr(reg: number, data: number): void; /** - * Reads a register from the LIS3MDL / MAX3110 Magnetometer. Can be used for configuring advanced functions. - * Check out [the Puck.js page on the magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information and links to modules that use this function. + * Reads a register from the LIS3MDL / MAX3110 Magnetometer. Can be used for + * configuring advanced functions. + * Check out [the Puck.js page on the + * magnetometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information and links to modules that use this function. * * @param {number} reg * @returns {number} @@ -598,7 +801,8 @@ declare class Puck { static magRd(reg: number): number; /** - * On Puck.js v2.0 this will use the on-board PCT2075TP temperature sensor, but on Puck.js the less accurate on-chip Temperature sensor is used. + * On Puck.js v2.0 this will use the on-board PCT2075TP temperature sensor, but on + * Puck.js the less accurate on-chip Temperature sensor is used. * @returns {number} Temperature in degrees C * @url http://www.espruino.com/Reference#l_Puck_getTemperature */ @@ -615,7 +819,8 @@ declare class Puck { * * 416 Hz (with Gyro) (not recommended) * * 833 Hz (with Gyro) (not recommended) * * 1660 Hz (with Gyro) (not recommended) - * Once `Puck.accelOn()` is called, the `Puck.accel` event will be called each time data is received. `Puck.accelOff()` can be called to turn the accelerometer off. + * Once `Puck.accelOn()` is called, the `Puck.accel` event will be called each time + * data is received. `Puck.accelOff()` can be called to turn the accelerometer off. * For instance to light the red LED whenever Puck.js is face up: * ``` * Puck.on('accel', function(a) { @@ -623,48 +828,57 @@ declare class Puck { * }); * Puck.accelOn(); * ``` - * Check out [the Puck.js page on the accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information. + * Check out [the Puck.js page on the + * accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information. * * @param {number} samplerate - The sample rate in Hz, or undefined * @url http://www.espruino.com/Reference#l_Puck_accelOn */ - static accelOn(samplerate: number): any; + static accelOn(samplerate: number): void; /** * Turn the accelerometer off after it has been turned on by `Puck.accelOn()`. - * Check out [the Puck.js page on the accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information. + * Check out [the Puck.js page on the + * accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information. * @url http://www.espruino.com/Reference#l_Puck_accelOff */ - static accelOff(): any; + static accelOff(): void; /** * Turn on the accelerometer, take a single reading, and then turn it off again. * The values reported are the raw values from the chip. In normal configuration: - * * accelerometer: full-scale (32768) is 4g, so you need to divide by 8192 to get correctly scaled values - * * gyro: full-scale (32768) is 245 dps, so you need to divide by 134 to get correctly scaled values - * If taking more than one reading, we'd suggest you use `Puck.accelOn()` and the `Puck.accel` event. + * * accelerometer: full-scale (32768) is 4g, so you need to divide by 8192 to get + * correctly scaled values + * * gyro: full-scale (32768) is 245 dps, so you need to divide by 134 to get + * correctly scaled values + * If taking more than one reading, we'd suggest you use `Puck.accelOn()` and the + * `Puck.accel` event. * @returns {any} An Object `{acc:{x,y,z}, gyro:{x,y,z}}` of accelerometer/gyro readings * @url http://www.espruino.com/Reference#l_Puck_accel */ static accel(): any; /** - * Writes a register on the LSM6DS3TR-C Accelerometer. Can be used for configuring advanced functions. - * Check out [the Puck.js page on the accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information and links to modules that use this function. + * Writes a register on the LSM6DS3TR-C Accelerometer. Can be used for configuring + * advanced functions. + * Check out [the Puck.js page on the + * accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information and links to modules that use this function. * * @param {number} reg * @param {number} data * @url http://www.espruino.com/Reference#l_Puck_accelWr */ - static accelWr(reg: number, data: number): any; + static accelWr(reg: number, data: number): void; /** - * Reads a register from the LSM6DS3TR-C Accelerometer. Can be used for configuring advanced functions. - * Check out [the Puck.js page on the accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) - * for more information and links to modules that use this function. + * Reads a register from the LSM6DS3TR-C Accelerometer. Can be used for configuring + * advanced functions. + * Check out [the Puck.js page on the + * accelerometer](http://www.espruino.com/Puck.js#on-board-peripherals) for more + * information and links to modules that use this function. * * @param {number} reg * @returns {number} @@ -673,21 +887,21 @@ declare class Puck { static accelRd(reg: number): number; /** - * Transmit the given set of IR pulses - data should be an array of pulse times - * in milliseconds (as `[on, off, on, off, on, etc]`). + * Transmit the given set of IR pulses - data should be an array of pulse times in + * milliseconds (as `[on, off, on, off, on, etc]`). * For example `Puck.IR(pulseTimes)` - see http://www.espruino.com/Puck.js+Infrared * for a full example. - * You can also attach an external LED to Puck.js, in which case - * you can just execute `Puck.IR(pulseTimes, led_cathode, led_anode)` - * It is also possible to just supply a single pin for IR transmission - * with `Puck.IR(pulseTimes, led_anode)` (on 2v05 and above). + * You can also attach an external LED to Puck.js, in which case you can just + * execute `Puck.IR(pulseTimes, led_cathode, led_anode)` + * It is also possible to just supply a single pin for IR transmission with + * `Puck.IR(pulseTimes, led_anode)` (on 2v05 and above). * * @param {any} data - An array of pulse lengths, in milliseconds * @param {Pin} cathode - (optional) pin to use for IR LED cathode - if not defined, the built-in IR LED is used * @param {Pin} anode - (optional) pin to use for IR LED anode - if not defined, the built-in IR LED is used * @url http://www.espruino.com/Reference#l_Puck_IR */ - static IR(data: any, cathode: Pin, anode: Pin): any; + static IR(data: any, cathode: Pin, anode: Pin): void; /** * Capacitive sense - the higher the capacitance, the higher the number returned. @@ -695,11 +909,10 @@ declare class Puck { * attached to pin D11 will be returned. If you attach a length of wire to D11, * you'll be able to see a higher value returned when your hand is near the wire * than when it is away. - * You can also supply pins to use yourself, however if you do this then - * the TX pin must be connected to RX pin and sense plate via a roughly 1MOhm - * resistor. - * When not supplying pins, Puck.js uses an internal resistor between D12(tx) - * and D11(rx). + * You can also supply pins to use yourself, however if you do this then the TX pin + * must be connected to RX pin and sense plate via a roughly 1MOhm resistor. + * When not supplying pins, Puck.js uses an internal resistor between D12(tx) and + * D11(rx). * * @param {Pin} tx * @param {Pin} rx @@ -710,8 +923,8 @@ declare class Puck { /** * Return a light value based on the light the red LED is seeing. - * **Note:** If called more than 5 times per second, the received light value - * may not be accurate. + * **Note:** If called more than 5 times per second, the received light value may + * not be accurate. * @returns {number} A light value from 0 to 1 * @url http://www.espruino.com/Reference#l_Puck_light */ @@ -719,22 +932,22 @@ declare class Puck { /** * DEPRECATED - Please use `E.getBattery()` instead. - * Return an approximate battery percentage remaining based on - * a normal CR2032 battery (2.8 - 2.2v). + * Return an approximate battery percentage remaining based on a normal CR2032 + * battery (2.8 - 2.2v). * @returns {number} A percentage between 0 and 100 * @url http://www.espruino.com/Reference#l_Puck_getBatteryPercentage */ static getBatteryPercentage(): number; /** - * Run a self-test, and return true for a pass. This checks for shorts - * between pins, so your Puck shouldn't have anything connected to it. - * **Note:** This self-test auto starts if you hold the button on your Puck - * down while inserting the battery, leave it pressed for 3 seconds (while - * the green LED is lit) and release it soon after all LEDs turn on. 5 - * red blinks is a fail, 5 green is a pass. - * If the self test fails, it'll set the Puck.js Bluetooth advertising name - * to `Puck.js !ERR` where ERR is a 3 letter error code. + * Run a self-test, and return true for a pass. This checks for shorts between + * pins, so your Puck shouldn't have anything connected to it. + * **Note:** This self-test auto starts if you hold the button on your Puck down + * while inserting the battery, leave it pressed for 3 seconds (while the green LED + * is lit) and release it soon after all LEDs turn on. 5 red blinks is a fail, 5 + * green is a pass. + * If the self test fails, it'll set the Puck.js Bluetooth advertising name to + * `Puck.js !ERR` where ERR is a 3 letter error code. * @returns {boolean} True if the self-test passed * @url http://www.espruino.com/Reference#l_Puck_selfTest */ @@ -744,9 +957,14 @@ declare class Puck { } /** - * This is the File object - it allows you to stream data to and from files (As opposed to the `require('fs').readFile(..)` style functions that read an entire file). - * To create a File object, you must type ```var fd = E.openFile('filepath','mode')``` - see [E.openFile](#l_E_openFile) for more information. - * **Note:** If you want to remove an SD card after you have started using it, you *must* call `E.unmountSD()` or you may cause damage to the card. + * This is the File object - it allows you to stream data to and from files (As + * opposed to the `require('fs').readFile(..)` style functions that read an entire + * file). + * To create a File object, you must type ```var fd = + * E.openFile('filepath','mode')``` - see [E.openFile](#l_E_openFile) for more + * information. + * **Note:** If you want to remove an SD card after you have started using it, you + * *must* call `E.unmountSD()` or you may cause damage to the card. * @url http://www.espruino.com/Reference#File */ declare class File { @@ -756,16 +974,15 @@ declare class File { * Close an open file. * @url http://www.espruino.com/Reference#l_File_close */ - close(): any; + close(): void; /** * Write data to a file. - * **Note:** By default this function flushes all changes to the - * SD card, which makes it slow (but also safe!). You can use - * `E.setFlags({unsyncFiles:1})` to disable this behaviour and - * really speed up writes - but then you must be sure to close - * all files you are writing before power is lost or you will - * cause damage to your SD card's filesystem. + * **Note:** By default this function flushes all changes to the SD card, which + * makes it slow (but also safe!). You can use `E.setFlags({unsyncFiles:1})` to + * disable this behaviour and really speed up writes - but then you must be sure to + * close all files you are writing before power is lost or you will cause damage to + * your SD card's filesystem. * * @param {any} buffer - A string containing the bytes to write * @returns {number} the number of bytes written @@ -788,7 +1005,7 @@ declare class File { * @param {number} nBytes - is a positive integer specifying the number of bytes to skip forwards. * @url http://www.espruino.com/Reference#l_File_skip */ - skip(nBytes: number): any; + skip(nBytes: number): void; /** * Seek to a certain position in the file @@ -796,7 +1013,7 @@ declare class File { * @param {number} nBytes - is an integer specifying the number of bytes to skip forwards. * @url http://www.espruino.com/Reference#l_File_seek */ - seek(nBytes: number): any; + seek(nBytes: number): void; /** * Pipe this file to a stream (an object with a 'write' method) @@ -809,7 +1026,7 @@ declare class File { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_File_pipe */ - pipe(destination: any, options: any): any; + pipe(destination: any, options: any): void; } /** @@ -825,24 +1042,26 @@ declare class WioLTE { * @param {number} blue - 0-255, blue LED intensity * @url http://www.espruino.com/Reference#l_WioLTE_LED */ - static LED(red: number, green: number, blue: number): any; + static LED(red: number, green: number, blue: number): void; /** - * Set the power of Grove connectors, except for `D38` and `D39` which are always on. + * Set the power of Grove connectors, except for `D38` and `D39` which are always + * on. * * @param {boolean} onoff - Whether to turn the Grove connectors power on or off (D38/D39 are always powered) * @url http://www.espruino.com/Reference#l_WioLTE_setGrovePower */ - static setGrovePower(onoff: boolean): any; + static setGrovePower(onoff: boolean): void; /** * Turn power to the WIO's LED on or off. - * Turning the LED on won't immediately display a color - that must be done with `WioLTE.LED(r,g,b)` + * Turning the LED on won't immediately display a color - that must be done with + * `WioLTE.LED(r,g,b)` * * @param {boolean} onoff - true = on, false = off * @url http://www.espruino.com/Reference#l_WioLTE_setLEDPower */ - static setLEDPower(onoff: boolean): any; + static setLEDPower(onoff: boolean): void; /** * @returns {any} @@ -884,14 +1103,15 @@ declare class WioLTE { } /** - * Class containing utility functions for [Pixl.js](http://www.espruino.com/Pixl.js) + * Class containing utility functions for + * [Pixl.js](http://www.espruino.com/Pixl.js) * @url http://www.espruino.com/Reference#Pixl */ declare class Pixl { /** * DEPRECATED - Please use `E.getBattery()` instead. - * Return an approximate battery percentage remaining based on - * a normal CR2032 battery (2.8 - 2.2v) + * Return an approximate battery percentage remaining based on a normal CR2032 + * battery (2.8 - 2.2v) * @returns {number} A percentage between 0 and 100 * @url http://www.espruino.com/Reference#l_Pixl_getBatteryPercentage */ @@ -903,7 +1123,7 @@ declare class Pixl { * @param {number} c - Contrast between 0 and 1 * @url http://www.espruino.com/Reference#l_Pixl_setContrast */ - static setContrast(c: number): any; + static setContrast(c: number): void; /** * This function can be used to turn Pixl.js's LCD off or on. @@ -913,7 +1133,7 @@ declare class Pixl { * @param {boolean} isOn - True if the LCD should be on, false if not * @url http://www.espruino.com/Reference#l_Pixl_setLCDPower */ - static setLCDPower(isOn: boolean): any; + static setLCDPower(isOn: boolean): void; /** * Writes a command directly to the ST7567 LCD controller @@ -921,23 +1141,28 @@ declare class Pixl { * @param {number} c * @url http://www.espruino.com/Reference#l_Pixl_lcdw */ - static lcdw(c: number): any; + static lcdw(c: number): void; /** - * Display a menu on Pixl.js's screen, and set up the buttons to navigate through it. + * Display a menu on Pixl.js's screen, and set up the buttons to navigate through + * it. * DEPRECATED: Use `E.showMenu` * * @param {any} menu - An object containing name->function mappings to to be used in a menu * @returns {any} A menu object with `draw`, `move` and `select` functions * @url http://www.espruino.com/Reference#l_Pixl_menu */ - static menu(menu: any): any; + static menu(menu: Menu): MenuInstance; } /** - * This class exists in order to interface Espruino with fast-moving trigger wheels. Trigger wheels are physical discs with evenly spaced teeth cut into them, and often with one or two teeth next to each other missing. A sensor sends a signal whenever a tooth passed by, and this allows a device to measure not only RPM, but absolute position. + * This class exists in order to interface Espruino with fast-moving trigger + * wheels. Trigger wheels are physical discs with evenly spaced teeth cut into + * them, and often with one or two teeth next to each other missing. A sensor sends + * a signal whenever a tooth passed by, and this allows a device to measure not + * only RPM, but absolute position. * This class is currently in testing - it is NOT AVAILABLE on normal boards. * @url http://www.espruino.com/Reference#Trig */ @@ -958,7 +1183,7 @@ declare class Trig { * @param {any} options - Additional options as an object. defaults are: ```{teethTotal:60,teethMissing:2,minRPM:30,keyPosition:0}``` * @url http://www.espruino.com/Reference#l_Trig_setup */ - static setup(pin: Pin, options: any): any; + static setup(pin: Pin, options: any): void; /** * Set a trigger for a certain point in the cycle @@ -969,7 +1194,7 @@ declare class Trig { * @param {number} pulseLength - The time (in msec) to pulse for * @url http://www.espruino.com/Reference#l_Trig_setTrigger */ - static setTrigger(num: number, pos: number, pins: any, pulseLength: number): any; + static setTrigger(num: number, pos: number, pins: any, pulseLength: number): void; /** * Disable a trigger @@ -977,7 +1202,7 @@ declare class Trig { * @param {number} num - The trigger number (0..7) * @url http://www.espruino.com/Reference#l_Trig_killTrigger */ - static killTrigger(num: number): any; + static killTrigger(num: number): void; /** * Get the current state of a trigger @@ -1014,7 +1239,9 @@ declare class Trig { /** * Class containing AES encryption/decryption - * **Note:** This library is currently only included in builds for boards where there is space. For other boards there is `crypto.js` which implements SHA1 in JS. + * **Note:** This library is currently only included in builds for boards where + * there is space. For other boards there is `crypto.js` which implements SHA1 in + * JS. * @url http://www.espruino.com/Reference#AES */ declare class AES { @@ -1043,23 +1270,28 @@ declare class AES { /** * This class provides Graphics operations that can be applied to a surface. - * Use Graphics.createXXX to create a graphics object that renders in the way you want. See [the Graphics page](https://www.espruino.com/Graphics) for more information. - * **Note:** On boards that contain an LCD, there is a built-in 'LCD' object of type Graphics. For instance to draw a line you'd type: ```LCD.drawLine(0,0,100,100)``` + * Use Graphics.createXXX to create a graphics object that renders in the way you + * want. See [the Graphics page](https://www.espruino.com/Graphics) for more + * information. + * **Note:** On boards that contain an LCD, there is a built-in 'LCD' object of + * type Graphics. For instance to draw a line you'd type: + * ```LCD.drawLine(0,0,100,100)``` * @url http://www.espruino.com/Reference#Graphics */ -declare class Graphics { +declare class Graphics { /** - * On devices like Pixl.js or HYSTM boards that contain a built-in display - * this will return an instance of the graphics class that can be used to - * access that display. + * On devices like Pixl.js or HYSTM boards that contain a built-in display this + * will return an instance of the graphics class that can be used to access that + * display. * Internally, this is stored as a member called `gfx` inside the 'hiddenRoot'. * @returns {any} An instance of `Graphics` or undefined * @url http://www.espruino.com/Reference#l_Graphics_getInstance */ - static getInstance(): any; + static getInstance(): Graphics | undefined /** - * Create a Graphics object that renders to an Array Buffer. This will have a field called 'buffer' that can get used to get at the buffer itself + * Create a Graphics object that renders to an Array Buffer. This will have a field + * called 'buffer' that can get used to get at the buffer itself * * @param {number} width - Pixels wide * @param {number} height - Pixels high @@ -1074,10 +1306,11 @@ declare class Graphics { * @returns {any} The new Graphics object * @url http://www.espruino.com/Reference#l_Graphics_createArrayBuffer */ - static createArrayBuffer(width: number, height: number, bpp: number, options: any): Graphics; + static createArrayBuffer(width: number, height: number, bpp: number, options?: { zigzag?: boolean, vertical_byte?: boolean, msb?: boolean, color_order?: "rgb" | "rbg" | "brg" | "bgr" | "grb" | "gbr" }): Graphics; /** - * Create a Graphics object that renders by calling a JavaScript callback function to draw pixels + * Create a Graphics object that renders by calling a JavaScript callback function + * to draw pixels * * @param {number} width - Pixels wide * @param {number} height - Pixels high @@ -1086,7 +1319,7 @@ declare class Graphics { * @returns {any} The new Graphics object * @url http://www.espruino.com/Reference#l_Graphics_createCallback */ - static createCallback(width: number, height: number, bpp: number, callback: any): Graphics; + static createCallback(width: number, height: number, bpp: number, callback: ((x: number, y: number, col: number) => void) | { setPixel: (x: number, y: number, col: number) => void; fillRect: (x1: number, y1: number, x2: number, y2: number, col: number) => void }): Graphics; /** * Create a Graphics object that renders to SDL window (Linux-based devices only) @@ -1113,14 +1346,14 @@ declare class Graphics { * `); * g.drawImage(img, x,y); * ``` - * If the characters at the beginning and end of the string are newlines, they - * will be ignored. Spaces are treated as `0`, and any other character is a `1` + * If the characters at the beginning and end of the string are newlines, they will + * be ignored. Spaces are treated as `0`, and any other character is a `1` * * @param {any} str - A String containing a newline-separated image - space is 0, anything else is 1 * @returns {any} An Image object that can be used with `Graphics.drawImage` * @url http://www.espruino.com/Reference#l_Graphics_createImage */ - static createImage(str: any): any; + static createImage(str: string): ImageObject; /** * Set the current font @@ -1141,34 +1374,28 @@ declare class Graphics { setFont12x20(scale: number): Graphics; /** - * On instances of graphics that drive a display with - * an offscreen buffer, calling this function will - * copy the contents of the offscreen buffer to the + * On instances of graphics that drive a display with an offscreen buffer, calling + * this function will copy the contents of the offscreen buffer to the screen. + * Call this when you have drawn something to Graphics and you want it shown on the * screen. - * Call this when you have drawn something to Graphics - * and you want it shown on the screen. - * If a display does not have an offscreen buffer, - * it may not have a `g.flip()` method. - * On Bangle.js 1, there are different graphics modes - * chosen with `Bangle.setLCDMode()`. The default mode - * is unbuffered and in this mode `g.flip()` does not - * affect the screen contents. - * On some devices, this command will attempt to - * only update the areas of the screen that have - * changed in order to increase speed. If you have - * accessed the `Graphics.buffer` directly then you - * may need to use `Graphics.flip(true)` to force - * a full update of the screen. + * If a display does not have an offscreen buffer, it may not have a `g.flip()` + * method. + * On Bangle.js 1, there are different graphics modes chosen with + * `Bangle.setLCDMode()`. The default mode is unbuffered and in this mode + * `g.flip()` does not affect the screen contents. + * On some devices, this command will attempt to only update the areas of the + * screen that have changed in order to increase speed. If you have accessed the + * `Graphics.buffer` directly then you may need to use `Graphics.flip(true)` to + * force a full update of the screen. * * @param {boolean} [all] - [optional] (only on some devices) If `true` then copy all pixels, not just those that have changed. * @url http://www.espruino.com/Reference#l_Graphics_flip */ - flip(all?: boolean): any; + flip(all?: boolean): void; /** - * On Graphics instances with an offscreen buffer, this - * is an `ArrayBuffer` that provides access to the underlying - * pixel data. + * On Graphics instances with an offscreen buffer, this is an `ArrayBuffer` that + * provides access to the underlying pixel data. * ``` * g=Graphics.createArrayBuffer(8,8,8) * g.drawLine(0,0,7,7) @@ -1186,7 +1413,7 @@ declare class Graphics { * @returns {any} An ArrayBuffer (or not defined on Graphics instances not created with `Graphics.createArrayBuffer`) * @url http://www.espruino.com/Reference#l_Graphics_buffer */ - buffer: any; + buffer: IsBuffer extends true ? ArrayBuffer : undefined /** * The width of this Graphics instance @@ -1204,18 +1431,18 @@ declare class Graphics { /** * The number of bits per pixel of this Graphics instance - * **Note:** Bangle.js 2 behaves a little differently here. The display - * is 3 bit, so `getBPP` returns 3 and `asBMP`/`asImage`/etc return 3 bit images. - * However in order to allow dithering, the colors returned by `Graphics.getColor` and `Graphics.theme` - * are actually 16 bits. + * **Note:** Bangle.js 2 behaves a little differently here. The display is 3 bit, + * so `getBPP` returns 3 and `asBMP`/`asImage`/etc return 3 bit images. However in + * order to allow dithering, the colors returned by `Graphics.getColor` and + * `Graphics.theme` are actually 16 bits. * @returns {number} The bits per pixel of this Graphics instance * @url http://www.espruino.com/Reference#l_Graphics_getBPP */ getBPP(): number; /** - * Reset the state of Graphics to the defaults (eg. Color, Font, etc) - * that would have been used when Graphics was initialised. + * Reset the state of Graphics to the defaults (e.g. Color, Font, etc) that would + * have been used when Graphics was initialised. * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_reset */ @@ -1224,11 +1451,11 @@ declare class Graphics { /** * Clear the LCD with the Background Color * - * @param {boolean} reset - If `true`, resets the state of Graphics to the default (eg. Color, Font, etc) as if calling `Graphics.reset` + * @param {boolean} [reset] - [optional] If `true`, resets the state of Graphics to the default (eg. Color, Font, etc) as if calling `Graphics.reset` * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_clear */ - clear(reset: boolean): Graphics; + clear(reset?: boolean): Graphics; /** * Fill a rectangular area in the Foreground Color @@ -1242,7 +1469,8 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_fillRect */ - fillRect(x1: any, y1: number, x2: number, y2: number): Graphics; + fillRect(x1: number, y1: number, x2: number, y2: number): Graphics; + fillRect(rect: { x: number, y: number, x2: number, y2: number } | { x: number, y: number, w: number, h: number }): Graphics; /** * Fill a rectangular area in the Background Color @@ -1256,7 +1484,8 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_clearRect */ - clearRect(x1: any, y1: number, x2: number, y2: number): Graphics; + clearRect(x1: number, y1: number, x2: number, y2: number): Graphics; + clearRect(rect: { x: number, y: number, x2: number, y2: number } | { x: number, y: number, w: number, h: number }): Graphics; /** * Draw an unfilled rectangle 1px wide in the Foreground Color @@ -1268,7 +1497,8 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawRect */ - drawRect(x1: any, y1: number, x2: number, y2: number): Graphics; + drawRect(x1: number, y1: number, x2: number, y2: number): Graphics; + drawRect(rect: { x: number, y: number, x2: number, y2: number } | { x: number, y: number, w: number, h: number }): Graphics; /** * Draw a filled circle in the Foreground Color @@ -1346,7 +1576,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setPixel */ - setPixel(x: number, y: number, col: any): Graphics; + setPixel(x: number, y: number, col?: ColorResolvable): Graphics; /** * Work out the color value to be used in the current bit depth based on the arguments. @@ -1364,7 +1594,8 @@ declare class Graphics { * @returns {number} The color index represented by the arguments * @url http://www.espruino.com/Reference#l_Graphics_toColor */ - toColor(r: any, g: any, b: any): number; + toColor(r: number, g: number, b: number): number; + toColor(col: ColorResolvable): number; /** * Blend between two colors, and return the result. @@ -1383,7 +1614,7 @@ declare class Graphics { * @returns {number} The color index represented by the blended colors * @url http://www.espruino.com/Reference#l_Graphics_blendColor */ - blendColor(col_a: any, col_b: any, amt: any): number; + blendColor(col_a: ColorResolvable, col_b: ColorResolvable, amt: number): number; /** * Set the color to use for subsequent drawing operations. @@ -1404,7 +1635,8 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setColor */ - setColor(r: any, g?: any, b?: any): Graphics; + setColor(r: number, g: number, b: number): number; + setColor(col: ColorResolvable): number; /** * Set the background color to use for subsequent drawing operations. @@ -1418,7 +1650,8 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setBgColor */ - setBgColor(r: any, g: any, b: any): Graphics; + setBgColor(r: number, g: number, b: number): number; + setBgColor(col: ColorResolvable): number; /** * Get the color to use for subsequent drawing operations @@ -1435,14 +1668,15 @@ declare class Graphics { getBgColor(): number; /** - * This sets the 'clip rect' that subsequent drawing operations are clipped to - * sit between. - * These values are inclusive - eg `g.setClipRect(1,0,5,0)` will ensure that only + * This sets the 'clip rect' that subsequent drawing operations are clipped to sit + * between. + * These values are inclusive - e.g. `g.setClipRect(1,0,5,0)` will ensure that only * pixel rows 1,2,3,4,5 are touched on column 0. - * **Note:** For maximum flexibility on Bangle.js 1, the values here are not range checked. For normal - * use, X and Y should be between 0 and `getWidth()-1`/`getHeight()-1`. - * **Note:** The x/y values here are rotated, so that if `Graphics.setRotation` is used - * they correspond to the coordinates given to the draw functions, *not to the + * **Note:** For maximum flexibility on Bangle.js 1, the values here are not range + * checked. For normal use, X and Y should be between 0 and + * `getWidth()-1`/`getHeight()-1`. + * **Note:** The x/y values here are rotated, so that if `Graphics.setRotation` is + * used they correspond to the coordinates given to the draw functions, *not to the * physical device pixels*. * * @param {number} x1 - Top left X coordinate @@ -1464,7 +1698,8 @@ declare class Graphics { /** * Make subsequent calls to `drawString` use a Vector Font of the given height. - * It is recommended that you use `Graphics.setFont("Vector", size)` for more flexibility. + * It is recommended that you use `Graphics.setFont("Vector", size)` for more + * flexibility. * * @param {number} size - The height of the font, as an integer * @returns {any} The instance of Graphics this was called on, to allow call chaining @@ -1473,11 +1708,14 @@ declare class Graphics { setFontVector(size: number): Graphics; /** - * Make subsequent calls to `drawString` use a Custom Font of the given height. See the [Fonts page](http://www.espruino.com/Fonts) for more - * information about custom fonts and how to create them. - * For examples of use, see the [font modules](https://www.espruino.com/Fonts#font-modules). - * **Note:** while you can specify the character code of the first character with `firstChar`, - * the newline character 13 will always be treated as a newline and not rendered. + * Make subsequent calls to `drawString` use a Custom Font of the given height. See + * the [Fonts page](http://www.espruino.com/Fonts) for more information about + * custom fonts and how to create them. + * For examples of use, see the [font + * modules](https://www.espruino.com/Fonts#font-modules). + * **Note:** while you can specify the character code of the first character with + * `firstChar`, the newline character 13 will always be treated as a newline and + * not rendered. * * @param {any} bitmap - A column-first, MSB-first, 1bpp bitmap containing the font bitmap * @param {number} firstChar - The first character in the font - usually 32 (space) @@ -1486,7 +1724,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setFontCustom */ - setFontCustom(bitmap: any, firstChar: number, width: any, height: number): Graphics; + setFontCustom(bitmap: ArrayBuffer, firstChar: number, width: number | string, height: number): Graphics; /** * Set the alignment for subsequent calls to `drawString` @@ -1497,7 +1735,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setFontAlign */ - setFontAlign(x: number, y: number, rotation: number): Graphics; + setFontAlign(x: -1 | 0 | 1, y?: -1 | 0 | 1, rotation?: 0 | 1 | 2 | 3): Graphics; /** * Set the font by name. Various forms are available: @@ -1516,27 +1754,28 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setFont */ - setFont(name: any, size: number): Graphics; + setFont(name: FontNameWithScaleFactor): Graphics; + setFont(name: FontName, size: number): Graphics; /** * Get the font by name - can be saved and used with `Graphics.setFont`. - * Normally this might return something like `"4x6"`, but if a scale - * factor is specified, a colon and then the size is reported, like "4x6:2" - * **Note:** For custom fonts, `Custom` is currently - * reported instead of the font name. + * Normally this might return something like `"4x6"`, but if a scale factor is + * specified, a colon and then the size is reported, like "4x6:2" + * **Note:** For custom fonts, `Custom` is currently reported instead of the font + * name. * @returns {any} Get the name of the current font * @url http://www.espruino.com/Reference#l_Graphics_getFont */ - getFont(): String; + getFont(): FontNameWithScaleFactor | "Custom" /** * Return an array of all fonts currently in the Graphics library. - * **Note:** Vector fonts are specified as `Vector#` where `#` is the font height. As there - * are effectively infinite fonts, just `Vector` is included in the list. + * **Note:** Vector fonts are specified as `Vector#` where `#` is the font height. + * As there are effectively infinite fonts, just `Vector` is included in the list. * @returns {any} And array of font names * @url http://www.espruino.com/Reference#l_Graphics_getFonts */ - getFonts(): any[]; + getFonts(): FontName[]; /** * Return the height in pixels of the current font @@ -1552,7 +1791,7 @@ declare class Graphics { * @returns {number} The length of the string in pixels * @url http://www.espruino.com/Reference#l_Graphics_stringWidth */ - stringWidth(str: any): number; + stringWidth(str: string): number; /** * Return the width and height in pixels of a string of text in the current font @@ -1561,7 +1800,7 @@ declare class Graphics { * @returns {any} An object containing `{width,height}` of the string * @url http://www.espruino.com/Reference#l_Graphics_stringMetrics */ - stringMetrics(str: any): any; + stringMetrics(str: string): { width: number, height: number }; /** * Wrap a string to the given pixel width using the current font, and return the @@ -1576,16 +1815,16 @@ declare class Graphics { * @returns {any} An array of lines that are all less than `maxWidth` * @url http://www.espruino.com/Reference#l_Graphics_wrapString */ - wrapString(str: any, maxWidth: number): any; + wrapString(str: string, maxWidth: number): string[]; /** * Draw a string of text in the current font. * ``` * g.drawString("Hello World", 10, 10); * ``` - * Images may also be embedded inside strings (eg to render Emoji or characters not in the current font). - * To do this, just add `0` then the image string ([about Images](http://www.espruino.com/Graphics#images-bitmaps)) - * For example: + * Images may also be embedded inside strings (e.g. to render Emoji or characters + * not in the current font). To do this, just add `0` then the image string ([about + * Images](http://www.espruino.com/Graphics#images-bitmaps)) For example: * ``` * g.drawString("Hi \0\7\5\1\x82 D\x17\xC0"); * // draws: @@ -1603,7 +1842,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawString */ - drawString(str: any, x: number, y: number, solid: boolean): Graphics; + drawString(str: string, x: number, y: number, solid?: boolean): Graphics; /** * Draw a line between x1,y1 and x2,y2 in the current foreground color @@ -1630,7 +1869,7 @@ declare class Graphics { drawLineAA(x1: number, y1: number, x2: number, y2: number): Graphics; /** - * Draw a line from the last position of lineTo or moveTo to this position + * Draw a line from the last position of `lineTo` or `moveTo` to this position * * @param {number} x - X value * @param {number} y - Y value @@ -1650,7 +1889,8 @@ declare class Graphics { moveTo(x: number, y: number): Graphics; /** - * Draw a polyline (lines between each of the points in `poly`) in the current foreground color + * Draw a polyline (lines between each of the points in `poly`) in the current + * foreground color * **Note:** there is a limit of 64 points (128 XY elements) for polygons * * @param {any} poly - An array of vertices, of the form ```[x1,y1,x2,y2,x3,y3,etc]``` @@ -1658,10 +1898,11 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawPoly */ - drawPoly(poly: any, closed: boolean): Graphics; + drawPoly(poly: number[], closed?: boolean): Graphics; /** - * Draw an **antialiased** polyline (lines between each of the points in `poly`) in the current foreground color + * Draw an **antialiased** polyline (lines between each of the points in `poly`) in + * the current foreground color * **Note:** there is a limit of 64 points (128 XY elements) for polygons * * @param {any} poly - An array of vertices, of the form ```[x1,y1,x2,y2,x3,y3,etc]``` @@ -1669,7 +1910,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawPolyAA */ - drawPolyAA(poly: any, closed: boolean): Graphics; + drawPolyAA(poly: number[], closed?: boolean): Graphics; /** * Draw a filled polygon in the current foreground color. @@ -1682,17 +1923,17 @@ declare class Graphics { * 6, 28, * 0, 27 ]); * ``` - * This fills from the top left hand side of the polygon (low X, low Y) - * *down to but not including* the bottom right. When placed together polygons - * will align perfectly without overdraw - but this will not fill the - * same pixels as `drawPoly` (drawing a line around the edge of the polygon). + * This fills from the top left hand side of the polygon (low X, low Y) *down to + * but not including* the bottom right. When placed together polygons will align + * perfectly without overdraw - but this will not fill the same pixels as + * `drawPoly` (drawing a line around the edge of the polygon). * **Note:** there is a limit of 64 points (128 XY elements) for polygons * * @param {any} poly - An array of vertices, of the form ```[x1,y1,x2,y2,x3,y3,etc]``` * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_fillPoly */ - fillPoly(poly: any): Graphics; + fillPoly(poly: number[]): Graphics; /** * Draw a filled polygon in the current foreground color. @@ -1705,17 +1946,17 @@ declare class Graphics { * 6, 28, * 0, 27 ]); * ``` - * This fills from the top left hand side of the polygon (low X, low Y) - * *down to but not including* the bottom right. When placed together polygons - * will align perfectly without overdraw - but this will not fill the - * same pixels as `drawPoly` (drawing a line around the edge of the polygon). + * This fills from the top left hand side of the polygon (low X, low Y) *down to + * but not including* the bottom right. When placed together polygons will align + * perfectly without overdraw - but this will not fill the same pixels as + * `drawPoly` (drawing a line around the edge of the polygon). * **Note:** there is a limit of 64 points (128 XY elements) for polygons * * @param {any} poly - An array of vertices, of the form ```[x1,y1,x2,y2,x3,y3,etc]``` * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_fillPolyAA */ - fillPolyAA(poly: any): Graphics; + fillPolyAA(poly: number[]): Graphics; /** * Set the current rotation of the graphics device. @@ -1725,34 +1966,47 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setRotation */ - setRotation(rotation: number, reflect: boolean): Graphics; + setRotation(rotation: 0 | 1 | 2 | 3, reflect?: boolean): Graphics; /** - * Return the width and height in pixels of an image (either Graphics, Image Object, Image String or ArrayBuffer). Returns - * `undefined` if image couldn't be decoded. - * `frames` is also included is the image contains more information than you'd expect for a single bitmap. In - * this case the bitmap might be an animation with multiple frames + * Return the width and height in pixels of an image (either Graphics, Image + * Object, Image String or ArrayBuffer). Returns `undefined` if image couldn't be + * decoded. + * `frames` is also included is the image contains more information than you'd + * expect for a single bitmap. In this case the bitmap might be an animation with + * multiple frames * * @param {any} str - The string * @returns {any} An object containing `{width,height,bpp,transparent}` for the image * @url http://www.espruino.com/Reference#l_Graphics_imageMetrics */ - imageMetrics(str: any): any; + imageMetrics(img: Image): { width: number, height: number, bpp: number, transparent: number, frames?: ArrayBuffer[] } | undefined; /** * Image can be: - * * An object with the following fields `{ width : int, height : int, bpp : optional int, buffer : ArrayBuffer/String, transparent: optional int, palette : optional Uint16Array(2/4/16) }`. bpp = bits per pixel (default is 1), transparent (if defined) is the colour that will be treated as transparent, and palette is a color palette that each pixel will be looked up in first - * * A String where the the first few bytes are: `width,height,bpp,[transparent,]image_bytes...`. If a transparent colour is specified the top bit of `bpp` should be set. - * * An ArrayBuffer Graphics object (if `bpp<8`, `msb:true` must be set) - this is disabled on devices without much flash memory available + * * An object with the following fields `{ width : int, height : int, bpp : + * optional int, buffer : ArrayBuffer/String, transparent: optional int, + * palette : optional Uint16Array(2/4/16) }`. bpp = bits per pixel (default is + * 1), transparent (if defined) is the colour that will be treated as + * transparent, and palette is a color palette that each pixel will be looked up + * in first + * * A String where the the first few bytes are: + * `width,height,bpp,[transparent,]image_bytes...`. If a transparent colour is + * specified the top bit of `bpp` should be set. + * * An ArrayBuffer Graphics object (if `bpp<8`, `msb:true` must be set) - this is + * disabled on devices without much flash memory available * Draw an image at the specified position. - * * If the image is 1 bit, the graphics foreground/background colours will be used. - * * If `img.palette` is a Uint16Array or 2/4/16 elements, color data will be looked from the supplied palette + * * If the image is 1 bit, the graphics foreground/background colours will be + * used. + * * If `img.palette` is a Uint16Array or 2/4/16 elements, color data will be + * looked from the supplied palette * * On Bangle.js, 2 bit images blend from background(0) to foreground(1) colours * * On Bangle.js, 4 bit images use the Apple Mac 16 color palette * * On Bangle.js, 8 bit images use the Web Safe 216 color palette * * Otherwise color data will be copied as-is. Bitmaps are rendered MSB-first - * If `options` is supplied, `drawImage` will allow images to be rendered at any scale or angle. If `options.rotate` is set it will - * center images at `x,y`. `options` must be an object of the form: + * If `options` is supplied, `drawImage` will allow images to be rendered at any + * scale or angle. If `options.rotate` is set it will center images at `x,y`. + * `options` must be an object of the form: * ``` * { * rotate : float, // the amount to rotate the image in radians (default 0) @@ -1779,7 +2033,7 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawImage */ - drawImage(image: any, x: number, y: number, options: any): Graphics; + drawImage(image: Image, x: number, y: number, options?: { rotate?: number, scale?: number, frame?: number }): Graphics; /** * Draws multiple images *at once* - which avoids flicker on unbuffered systems @@ -1807,43 +2061,45 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_drawImages */ - drawImages(layers: any, options: any): Graphics; + drawImages(layers: { x: number, y: number, image: Image, scale?: number, rotate?: number, center?: boolean, repeat?: boolean, nobounds?: boolean }[], options?: { x: number, y: number, width: number, height: number }): Graphics; /** - * Return this Graphics object as an Image that can be used with `Graphics.drawImage`. - * Check out [the Graphics reference page](http://www.espruino.com/Graphics#images-bitmaps) - * for more information on images. + * Return this Graphics object as an Image that can be used with + * `Graphics.drawImage`. Check out [the Graphics reference + * page](http://www.espruino.com/Graphics#images-bitmaps) for more information on + * images. * Will return undefined if data can't be allocated for the image. * The image data itself will be referenced rather than copied if: * * An image `object` was requested (not `string`) * * The Graphics instance was created with `Graphics.createArrayBuffer` * * Is 8 bpp *OR* the `{msb:true}` option was given * * No other format options (zigzag/etc) were given - * Otherwise data will be copied, which takes up more space and - * may be quite slow. + * Otherwise data will be copied, which takes up more space and may be quite slow. * * @param {any} type - The type of image to return. Either `object`/undefined to return an image object, or `string` to return an image string * @returns {any} An Image that can be used with `Graphics.drawImage` * @url http://www.espruino.com/Reference#l_Graphics_asImage */ - asImage(type: any): any; + asImage(type?: "object"): ImageObject; + asImage(type: "string"): string; /** - * Return the area of the Graphics canvas that has been modified, and optionally clear - * the modified area to 0. - * For instance if `g.setPixel(10,20)` was called, this would return `{x1:10, y1:20, x2:10, y2:20}` + * Return the area of the Graphics canvas that has been modified, and optionally + * clear the modified area to 0. + * For instance if `g.setPixel(10,20)` was called, this would return `{x1:10, + * y1:20, x2:10, y2:20}` * * @param {boolean} reset - Whether to reset the modified area or not * @returns {any} An object {x1,y1,x2,y2} containing the modified area, or undefined if not modified * @url http://www.espruino.com/Reference#l_Graphics_getModified */ - getModified(reset: boolean): any; + getModified(reset?: boolean): { x1: number, y1: number, x2: number, y2: number }; /** * Scroll the contents of this graphics in a certain direction. The remaining area * is filled with the background color. - * Note: This uses repeated pixel reads and writes, so will not work on platforms that - * don't support pixel reads. + * Note: This uses repeated pixel reads and writes, so will not work on platforms + * that don't support pixel reads. * * @param {number} x - X direction. >0 = to right * @param {number} y - Y direction. >0 = down @@ -1862,44 +2118,50 @@ declare class Graphics { * setModified : true // should we set the modified area? * }); * ``` - * Note: This uses repeated pixel reads and writes, so will not work on platforms that - * don't support pixel reads. + * Note: This uses repeated pixel reads and writes, so will not work on platforms + * that don't support pixel reads. * * @param {any} options - options - see below * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_blit */ - blit(options: any): Graphics; + blit(options: { x1: number, y1: number, x2: number, y2: number, w: number, h: number, setModified?: boolean }): Graphics; /** - * Create a Windows BMP file from this Graphics instance, and return it as a String. + * Create a Windows BMP file from this Graphics instance, and return it as a + * String. * @returns {any} A String representing the Graphics as a Windows BMP file (or 'undefined' if not possible) * @url http://www.espruino.com/Reference#l_Graphics_asBMP */ - asBMP(): any; + asBMP(): string; /** - * Create a URL of the form `data:image/bmp;base64,...` that can be pasted into the browser. - * The Espruino Web IDE can detect this data on the console and render the image inline automatically. + * Create a URL of the form `data:image/bmp;base64,...` that can be pasted into the + * browser. + * The Espruino Web IDE can detect this data on the console and render the image + * inline automatically. * @returns {any} A String representing the Graphics as a URL (or 'undefined' if not possible) * @url http://www.espruino.com/Reference#l_Graphics_asURL */ - asURL(): any; + asURL(): string; /** - * Output this image as a bitmap URL of the form `data:image/bmp;base64,...`. The Espruino Web IDE will detect this on the console and will render the image inline automatically. - * This is identical to `console.log(g.asURL())` - it is just a convenient function for easy debugging and producing screenshots of what is currently in the Graphics instance. - * **Note:** This may not work on some bit depths of Graphics instances. It will also not work for the main Graphics instance - * of Bangle.js 1 as the graphics on Bangle.js 1 are stored in write-only memory. + * Output this image as a bitmap URL of the form `data:image/bmp;base64,...`. The + * Espruino Web IDE will detect this on the console and will render the image + * inline automatically. + * This is identical to `console.log(g.asURL())` - it is just a convenient function + * for easy debugging and producing screenshots of what is currently in the + * Graphics instance. + * **Note:** This may not work on some bit depths of Graphics instances. It will + * also not work for the main Graphics instance of Bangle.js 1 as the graphics on + * Bangle.js 1 are stored in write-only memory. * @url http://www.espruino.com/Reference#l_Graphics_dump */ - dump(): any; + dump(): void; /** * Calculate the square area under a Bezier curve. - * x0,y0: start point - * x1,y1: control point - * y2,y2: end point + * x0,y0: start point x1,y1: control point y2,y2: end point * Max 10 points without start point. * * @param {any} arr - An array of three vertices, six enties in form of ```[x0,y0,x1,y1,x2,y2]``` @@ -1907,7 +2169,7 @@ declare class Graphics { * @returns {any} Array with calculated points * @url http://www.espruino.com/Reference#l_Graphics_quadraticBezier */ - quadraticBezier(arr: any, options: any): any; + quadraticBezier(arr: [number, number, number, number, number, number], options?: number): number[]; /** * Transformation can be: @@ -1933,7 +2195,7 @@ declare class Graphics { * @returns {any} Array of transformed vertices * @url http://www.espruino.com/Reference#l_Graphics_transformVertices */ - transformVertices(verts: any, transformation: any): any; + transformVertices(arr: number[], transformation: { x?: number, y?: number, scale?: number, rotate?: number } | [number, number, number, number, number, number]): number[]; /** * Returns an object of the form: @@ -1945,22 +2207,26 @@ declare class Graphics { * bg2 : 0x0007, // accented background colour * fgH : 0xFFFF, // highlighted foreground colour * bgH : 0x02F7, // highlighted background colour - * dark : true, // Is background dark (eg. foreground should be a light colour) + * dark : true, // Is background dark (e.g. foreground should be a light colour) * } * ``` - * These values can then be passed to `g.setColor`/`g.setBgColor` for example `g.setColor(g.theme.fg2)`. When the Graphics - * instance is reset, the background color is automatically set to `g.theme.bg` and foreground is set to `g.theme.fg`. - * On Bangle.js these values can be changed by writing updated values to `theme` in `settings.js` and reloading the app - or they can - * be changed temporarily by calling `Graphics.setTheme` + * These values can then be passed to `g.setColor`/`g.setBgColor` for example + * `g.setColor(g.theme.fg2)`. When the Graphics instance is reset, the background + * color is automatically set to `g.theme.bg` and foreground is set to + * `g.theme.fg`. + * On Bangle.js these values can be changed by writing updated values to `theme` in + * `settings.js` and reloading the app - or they can be changed temporarily by + * calling `Graphics.setTheme` * @returns {any} An object containing the current 'theme' (see below) * @url http://www.espruino.com/Reference#l_Graphics_theme */ - theme: any; + theme: Theme; /** - * Set the global colour scheme. On Bangle.js, this is reloaded from `settings.json` for each new app loaded. - * See `Graphics.theme` for the fields that can be provided. For instance you can change - * the background to red using: + * Set the global colour scheme. On Bangle.js, this is reloaded from + * `settings.json` for each new app loaded. + * See `Graphics.theme` for the fields that can be provided. For instance you can + * change the background to red using: * ``` * g.setTheme({bg:"#f00"}); * ``` @@ -1969,18 +2235,20 @@ declare class Graphics { * @returns {any} The instance of Graphics this was called on, to allow call chaining * @url http://www.espruino.com/Reference#l_Graphics_setTheme */ - setTheme(theme: any): Graphics; + setTheme(theme: { [key in keyof Theme]?: Theme[key] extends number ? ColorResolvable : Theme[key] }): Graphics; } /** - * This class helps to convert URLs into Objects of information ready for http.request/get + * This class helps to convert URLs into Objects of information ready for + * http.request/get * @url http://www.espruino.com/Reference#url */ declare class url { /** * A utility function to split a URL into parts * This is useful in web servers for instance when handling a request. - * For instance `url.parse("/a?b=c&d=e",true)` returns `{"method":"GET","host":"","path":"/a?b=c&d=e","pathname":"/a","search":"?b=c&d=e","port":80,"query":{"b":"c","d":"e"}}` + * For instance `url.parse("/a?b=c&d=e",true)` returns + * `{"method":"GET","host":"","path":"/a?b=c&d=e","pathname":"/a","search":"?b=c&d=e","port":80,"query":{"b":"c","d":"e"}}` * * @param {any} urlStr - A URL to be parsed * @param {boolean} parseQuery - Whether to parse the query string into an object not (default = false) @@ -2012,7 +2280,7 @@ declare class Server { * Stop listening for new connections * @url http://www.espruino.com/Reference#l_Server_close */ - close(): any; + close(): void; } /** @@ -2021,7 +2289,9 @@ declare class Server { */ declare class Socket { /** - * The 'data' event is called when data is received. If a handler is defined with `X.on('data', function(data) { ... })` then it will be called, otherwise data will be stored in an internal buffer, where it can be retrieved with `X.read()` + * The 'data' event is called when data is received. If a handler is defined with + * `X.on('data', function(data) { ... })` then it will be called, otherwise data + * will be stored in an internal buffer, where it can be retrieved with `X.read()` * @param {string} event - The event to listen to. * @param {(data: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `data` A string containing one or more characters of received data @@ -2039,9 +2309,11 @@ declare class Socket { static on(event: "close", callback: (had_error: any) => void): void; /** - * There was an error on this socket and it is closing (or wasn't opened in the first place). If a "connected" event was issued on this socket then the error event is always followed by a close event. - * The error codes are: - * * -1: socket closed (this is not really an error and will not cause an error callback) + * There was an error on this socket and it is closing (or wasn't opened in the + * first place). If a "connected" event was issued on this socket then the error + * event is always followed by a close event. The error codes are: + * * -1: socket closed (this is not really an error and will not cause an error + * callback) * * -2: out of memory (typically while allocating a buffer to hold data) * * -3: timeout * * -4: no route @@ -2063,7 +2335,8 @@ declare class Socket { static on(event: "error", callback: (details: any) => void): void; /** - * An event that is fired when the buffer is empty and it can accept more data to send. + * An event that is fired when the buffer is empty and it can accept more data to + * send. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Socket_drain @@ -2071,7 +2344,8 @@ declare class Socket { static on(event: "drain", callback: () => void): void; /** - * Return how many bytes are available to read. If there is already a listener for data, this will always return 0. + * Return how many bytes are available to read. If there is already a listener for + * data, this will always return 0. * @returns {number} How many bytes are available * @url http://www.espruino.com/Reference#l_Socket_available */ @@ -2097,7 +2371,7 @@ declare class Socket { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_Socket_pipe */ - pipe(destination: any, options: any): any; + pipe(destination: any, options: any): void; /** * This function writes the `data` argument as a string. Data that is passed in @@ -2105,8 +2379,8 @@ declare class Socket { * `toString` method. * If you wish to send binary data then you need to convert that data directly to a * String. This can be done with `String.fromCharCode`, however it's often easier - * and faster to use the Espruino-specific `E.toString`, which will read its arguments - * as an array of bytes and convert that to a String: + * and faster to use the Espruino-specific `E.toString`, which will read its + * arguments as an array of bytes and convert that to a String: * ``` * socket.write(E.toString([0,1,2,3,4,5])); * ``` @@ -2132,7 +2406,7 @@ declare class Socket { * @param {any} data - A string containing data to send * @url http://www.espruino.com/Reference#l_Socket_end */ - end(data: any): any; + end(data: any): void; } /** @@ -2141,7 +2415,8 @@ declare class Socket { */ declare class dgramSocket { /** - * The 'message' event is called when a datagram message is received. If a handler is defined with `X.on('message', function(msg) { ... })` then it will be called` + * The 'message' event is called when a datagram message is received. If a handler + * is defined with `X.on('message', function(msg) { ... })` then it will be called` * @param {string} event - The event to listen to. * @param {(msg: any, rinfo: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `msg` A string containing the received message @@ -2167,7 +2442,7 @@ declare class dgramSocket { * @param {any} args - Destination port number, Destination IP address string * @url http://www.espruino.com/Reference#l_dgramSocket_send */ - send(buffer: any, offset: any, length: any, ...args: any[]): any; + send(buffer: any, offset: any, length: any, ...args: any[]): void; /** * @@ -2182,7 +2457,7 @@ declare class dgramSocket { * Close the socket * @url http://www.espruino.com/Reference#l_dgramSocket_close */ - close(): any; + close(): void; /** * @@ -2190,7 +2465,7 @@ declare class dgramSocket { * @param {any} ip - A string containing the ip to join with * @url http://www.espruino.com/Reference#l_dgramSocket_addMembership */ - addMembership(group: any, ip: any): any; + addMembership(group: any, ip: any): void; } /** @@ -2212,16 +2487,18 @@ declare class WLAN { connect(ap: any, key: any, callback: any): boolean; /** - * Completely uninitialise and power down the CC3000. After this you'll have to use ```require("CC3000").connect()``` again. + * Completely uninitialise and power down the CC3000. After this you'll have to use + * ```require("CC3000").connect()``` again. * @url http://www.espruino.com/Reference#l_WLAN_disconnect */ - disconnect(): any; + disconnect(): void; /** - * Completely uninitialise and power down the CC3000, then reconnect to the old access point. + * Completely uninitialise and power down the CC3000, then reconnect to the old + * access point. * @url http://www.espruino.com/Reference#l_WLAN_reconnect */ - reconnect(): any; + reconnect(): void; /** * Get the current IP address @@ -2231,8 +2508,10 @@ declare class WLAN { getIP(): any; /** - * Set the current IP address for get an IP from DHCP (if no options object is specified). - * **Note:** Changes are written to non-volatile memory, but will only take effect after calling `wlan.reconnect()` + * Set the current IP address for get an IP from DHCP (if no options object is + * specified). + * **Note:** Changes are written to non-volatile memory, but will only take effect + * after calling `wlan.reconnect()` * * @param {any} options - Object containing IP address options `{ ip : '1,2,3,4', subnet, gateway, dns }`, or do not supply an object in otder to force DHCP. * @returns {boolean} True on success @@ -2242,29 +2521,33 @@ declare class WLAN { } /** - * Class containing utility functions for the [ESP8266](http://www.espruino.com/EspruinoESP8266) + * Class containing utility functions for the + * [ESP8266](http://www.espruino.com/EspruinoESP8266) * @url http://www.espruino.com/Reference#ESP8266 */ declare class ESP8266 { /** * **DEPRECATED** - please use `Wifi.ping` instead. - * Perform a network ping request. The parameter can be either a String or a numeric IP address. + * Perform a network ping request. The parameter can be either a String or a + * numeric IP address. * * @param {any} ipAddr - A string representation of an IP address. * @param {any} pingCallback - Optional callback function. * @url http://www.espruino.com/Reference#l_ESP8266_ping */ - static ping(ipAddr: any, pingCallback: any): any; + static ping(ipAddr: any, pingCallback: any): void; /** * Perform a hardware reset/reboot of the esp8266. * @url http://www.espruino.com/Reference#l_ESP8266_reboot */ - static reboot(): any; + static reboot(): void; /** - * At boot time the esp8266's firmware captures the cause of the reset/reboot. This function returns this information in an object with the following fields: - * * `reason`: "power on", "wdt reset", "exception", "soft wdt", "restart", "deep sleep", or "reset pin" + * At boot time the esp8266's firmware captures the cause of the reset/reboot. This + * function returns this information in an object with the following fields: + * * `reason`: "power on", "wdt reset", "exception", "soft wdt", "restart", "deep + * sleep", or "reset pin" * * `exccause`: exception cause * * `epc1`, `epc2`, `epc3`: instruction pointers * * `excvaddr`: address being accessed @@ -2275,59 +2558,66 @@ declare class ESP8266 { static getResetInfo(): any; /** - * Enable or disable the logging of debug information. A value of `true` enables debug logging while a value of `false` disables debug logging. Debug output is sent to UART1 (gpio2). + * Enable or disable the logging of debug information. A value of `true` enables + * debug logging while a value of `false` disables debug logging. Debug output is + * sent to UART1 (gpio2). * * @param {boolean} enable - Enable or disable the debug logging. * @url http://www.espruino.com/Reference#l_ESP8266_logDebug */ - static logDebug(enable: boolean): any; + static logDebug(enable: boolean): void; /** - * Set the debug logging mode. It can be disabled (which frees ~1.2KB of heap), enabled in-memory only, or in-memory and output to a UART. + * Set the debug logging mode. It can be disabled (which frees ~1.2KB of heap), + * enabled in-memory only, or in-memory and output to a UART. * * @param {number} mode - Debug log mode: 0=off, 1=in-memory only, 2=in-mem and uart0, 3=in-mem and uart1. * @url http://www.espruino.com/Reference#l_ESP8266_setLog */ - static setLog(mode: number): any; + static setLog(mode: number): void; /** * Prints the contents of the debug log to the console. * @url http://www.espruino.com/Reference#l_ESP8266_printLog */ - static printLog(): any; + static printLog(): void; /** * Returns one line from the log or up to 128 characters. * @url http://www.espruino.com/Reference#l_ESP8266_readLog */ - static readLog(): any; + static readLog(): void; /** - * Dumps info about all sockets to the log. This is for troubleshooting the socket implementation. + * Dumps info about all sockets to the log. This is for troubleshooting the socket + * implementation. * @url http://www.espruino.com/Reference#l_ESP8266_dumpSocketInfo */ - static dumpSocketInfo(): any; + static dumpSocketInfo(): void; /** - * **Note:** This is deprecated. Use `E.setClock(80/160)` - * **Note:** - * Set the operating frequency of the ESP8266 processor. The default is 160Mhz. - * **Warning**: changing the cpu frequency affects the timing of some I/O operations, notably of software SPI and I2C, so things may be a bit slower at 80Mhz. + * **Note:** This is deprecated. Use `E.setClock(80/160)` **Note:** Set the + * operating frequency of the ESP8266 processor. The default is 160Mhz. + * **Warning**: changing the cpu frequency affects the timing of some I/O + * operations, notably of software SPI and I2C, so things may be a bit slower at + * 80Mhz. * * @param {any} freq - Desired frequency - either 80 or 160. * @url http://www.espruino.com/Reference#l_ESP8266_setCPUFreq */ - static setCPUFreq(freq: any): any; + static setCPUFreq(freq: any): void; /** - * Returns an object that contains details about the state of the ESP8266 with the following fields: - * * `sdkVersion` - Version of the SDK. + * Returns an object that contains details about the state of the ESP8266 with the + * following fields: + * * `sdkVersion` - Version of the SDK. * * `cpuFrequency` - CPU operating frequency in Mhz. - * * `freeHeap` - Amount of free heap in bytes. - * * `maxCon` - Maximum number of concurrent connections. - * * `flashMap` - Configured flash size&map: '512KB:256/256' .. '4MB:512/512' - * * `flashKB` - Configured flash size in KB as integer - * * `flashChip` - Type of flash chip as string with manufacturer & chip, ex: '0xEF 0x4016` + * * `freeHeap` - Amount of free heap in bytes. + * * `maxCon` - Maximum number of concurrent connections. + * * `flashMap` - Configured flash size&map: '512KB:256/256' .. '4MB:512/512' + * * `flashKB` - Configured flash size in KB as integer + * * `flashChip` - Type of flash chip as string with manufacturer & chip, ex: '0xEF + * 0x4016` * @returns {any} The state of the ESP8266 * @url http://www.espruino.com/Reference#l_ESP8266_getState */ @@ -2349,31 +2639,36 @@ declare class ESP8266 { static crc32(arrayOfData: any): any; /** - * **This function is deprecated.** Please use `require("neopixel").write(pin, data)` instead + * **This function is deprecated.** Please use `require("neopixel").write(pin, + * data)` instead * * @param {Pin} pin - Pin for output signal. * @param {any} arrayOfData - Array of LED data. * @url http://www.espruino.com/Reference#l_ESP8266_neopixelWrite */ - static neopixelWrite(pin: Pin, arrayOfData: any): any; + static neopixelWrite(pin: Pin, arrayOfData: any): void; /** - * Put the ESP8266 into 'deep sleep' for the given number of microseconds, - * reducing power consumption drastically. + * Put the ESP8266 into 'deep sleep' for the given number of microseconds, reducing + * power consumption drastically. * meaning of option values: - * 0 - the 108th Byte of init parameter decides whether RF calibration will be performed or not. + * 0 - the 108th Byte of init parameter decides whether RF calibration will be + * performed or not. * 1 - run RF calibration after waking up. Power consumption is high. * 2 - no RF calibration after waking up. Power consumption is low. * 4 - no RF after waking up. Power consumption is the lowest. - * **Note:** unlike normal Espruino boards' 'deep sleep' mode, ESP8266 deep sleep actually turns off the processor. After the given number of microseconds have elapsed, the ESP8266 will restart as if power had been turned off and then back on. *All contents of RAM will be lost*. - * Connect GPIO 16 to RST to enable wakeup. - * **Special:** 0 microseconds cause sleep forever until external wakeup RST pull down occurs. + * **Note:** unlike normal Espruino boards' 'deep sleep' mode, ESP8266 deep sleep + * actually turns off the processor. After the given number of microseconds have + * elapsed, the ESP8266 will restart as if power had been turned off and then back + * on. *All contents of RAM will be lost*. Connect GPIO 16 to RST to enable wakeup. + * **Special:** 0 microseconds cause sleep forever until external wakeup RST pull + * down occurs. * * @param {any} micros - Number of microseconds to sleep. * @param {any} option - posible values are 0, 1, 2 or 4 * @url http://www.espruino.com/Reference#l_ESP8266_deepSleep */ - static deepSleep(micros: any, option: any): any; + static deepSleep(micros: any, option: any): void; } @@ -2395,9 +2690,10 @@ declare class Ethernet { getIP(options: any): any; /** - * Set the current IP address or get an IP from DHCP (if no options object is specified) - * If 'mac' is specified as an option, it must be a string of the form `"00:01:02:03:04:05"` - * The default mac is 00:08:DC:01:02:03. + * Set the current IP address or get an IP from DHCP (if no options object is + * specified) + * If 'mac' is specified as an option, it must be a string of the form + * `"00:01:02:03:04:05"` The default mac is 00:08:DC:01:02:03. * * @param {any} options - Object containing IP address options `{ ip : '1.2.3.4', subnet : '...', gateway: '...', dns:'...', mac:':::::' }`, or do not supply an object in order to force DHCP. * @param {any} callback - An optional `callback(err)` function to invoke when ip is set. `err==null` on success, or a string on failure. @@ -2407,10 +2703,10 @@ declare class Ethernet { setIP(options: any, callback: any): boolean; /** - * Set hostname allow to set the hosname used during the dhcp request. - * min 8 and max 12 char, best set before calling `eth.setIP()` - * Default is WIZnet010203, 010203 is the default nic as part of the mac. - * Best to set the hosname before calling setIP(). + * Set hostname allow to set the hosname used during the dhcp request. min 8 and + * max 12 char, best set before calling `eth.setIP()` Default is WIZnet010203, + * 010203 is the default nic as part of the mac. Best to set the hosname before + * calling setIP(). * * @param {any} hostname - hostname as string * @param {any} callback - An optional `callback(err)` function to be called back with null or error text. @@ -2458,7 +2754,7 @@ declare class httpSrv { * Stop listening for new HTTP connections * @url http://www.espruino.com/Reference#l_httpSrv_close */ - close(): any; + close(): void; } /** @@ -2467,7 +2763,9 @@ declare class httpSrv { */ declare class httpSRq { /** - * The 'data' event is called when data is received. If a handler is defined with `X.on('data', function(data) { ... })` then it will be called, otherwise data will be stored in an internal buffer, where it can be retrieved with `X.read()` + * The 'data' event is called when data is received. If a handler is defined with + * `X.on('data', function(data) { ... })` then it will be called, otherwise data + * will be stored in an internal buffer, where it can be retrieved with `X.read()` * @param {string} event - The event to listen to. * @param {(data: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `data` A string containing one or more characters of received data @@ -2507,7 +2805,8 @@ declare class httpSRq { url: any; /** - * Return how many bytes are available to read. If there is already a listener for data, this will always return 0. + * Return how many bytes are available to read. If there is already a listener for + * data, this will always return 0. * @returns {number} How many bytes are available * @url http://www.espruino.com/Reference#l_httpSRq_available */ @@ -2533,7 +2832,7 @@ declare class httpSRq { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_httpSRq_pipe */ - pipe(destination: any, options: any): any; + pipe(destination: any, options: any): void; } /** @@ -2542,7 +2841,8 @@ declare class httpSRq { */ declare class httpSRs { /** - * An event that is fired when the buffer is empty and it can accept more data to send. + * An event that is fired when the buffer is empty and it can accept more data to + * send. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_httpSRs_drain @@ -2573,7 +2873,8 @@ declare class httpSRs { /** * This function writes the `data` argument as a string. Data that is passed in * (including arrays) will be converted to a string with the normal JavaScript - * `toString` method. For more information about sending binary data see `Socket.write` + * `toString` method. For more information about sending binary data see + * `Socket.write` * * @param {any} data - A string containing data to send * @returns {boolean} For node.js compatibility, returns the boolean false. When the send buffer is empty, a `drain` event will be sent @@ -2587,30 +2888,31 @@ declare class httpSRs { * @param {any} data - A string containing data to send * @url http://www.espruino.com/Reference#l_httpSRs_end */ - end(data: any): any; + end(data: any): void; /** - * Send the given status code and headers. If not explicitly called - * this will be done automatically the first time data is written - * to the response. - * This cannot be called twice, or after data has already been sent - * in the response. + * Send the given status code and headers. If not explicitly called this will be + * done automatically the first time data is written to the response. + * This cannot be called twice, or after data has already been sent in the + * response. * * @param {number} statusCode - The HTTP status code * @param {any} headers - An object containing the headers * @url http://www.espruino.com/Reference#l_httpSRs_writeHead */ - writeHead(statusCode: number, headers: any): any; + writeHead(statusCode: number, headers: any): void; /** - * Set a value to send in the header of this HTTP response. This updates the `httpSRs.headers` property. - * Any headers supplied to `writeHead` will overwrite any headers with the same name. + * Set a value to send in the header of this HTTP response. This updates the + * `httpSRs.headers` property. + * Any headers supplied to `writeHead` will overwrite any headers with the same + * name. * * @param {any} name - The name of the header as a String * @param {any} value - The value of the header as a String * @url http://www.espruino.com/Reference#l_httpSRs_setHeader */ - setHeader(name: any, value: any): any; + setHeader(name: any, value: any): void; } /** @@ -2619,7 +2921,8 @@ declare class httpSRs { */ declare class httpCRq { /** - * An event that is fired when the buffer is empty and it can accept more data to send. + * An event that is fired when the buffer is empty and it can accept more data to + * send. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_httpCRq_drain @@ -2627,7 +2930,10 @@ declare class httpCRq { static on(event: "drain", callback: () => void): void; /** - * An event that is fired if there is an error making the request and the response callback has not been invoked. In this case the error event concludes the request attempt. The error event function receives an error object as parameter with a `code` field and a `message` field. + * An event that is fired if there is an error making the request and the response + * callback has not been invoked. In this case the error event concludes the + * request attempt. The error event function receives an error object as parameter + * with a `code` field and a `message` field. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_httpCRq_error @@ -2637,7 +2943,8 @@ declare class httpCRq { /** * This function writes the `data` argument as a string. Data that is passed in * (including arrays) will be converted to a string with the normal JavaScript - * `toString` method. For more information about sending binary data see `Socket.write` + * `toString` method. For more information about sending binary data see + * `Socket.write` * * @param {any} data - A string containing data to send * @returns {boolean} For node.js compatibility, returns the boolean false. When the send buffer is empty, a `drain` event will be sent @@ -2652,16 +2959,19 @@ declare class httpCRq { * @param {any} data - A string containing data to send * @url http://www.espruino.com/Reference#l_httpCRq_end */ - end(data: any): any; + end(data: any): void; } /** - * The HTTP client response, passed to the callback of `http.request()` an `http.get()`. + * The HTTP client response, passed to the callback of `http.request()` an + * `http.get()`. * @url http://www.espruino.com/Reference#httpCRs */ declare class httpCRs { /** - * The 'data' event is called when data is received. If a handler is defined with `X.on('data', function(data) { ... })` then it will be called, otherwise data will be stored in an internal buffer, where it can be retrieved with `X.read()` + * The 'data' event is called when data is received. If a handler is defined with + * `X.on('data', function(data) { ... })` then it will be called, otherwise data + * will be stored in an internal buffer, where it can be retrieved with `X.read()` * @param {string} event - The event to listen to. * @param {(data: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `data` A string containing one or more characters of received data @@ -2670,7 +2980,8 @@ declare class httpCRs { static on(event: "data", callback: (data: any) => void): void; /** - * Called when the connection closes with one `hadError` boolean parameter, which indicates whether an error occurred. + * Called when the connection closes with one `hadError` boolean parameter, which + * indicates whether an error occurred. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_httpCRs_close @@ -2678,7 +2989,10 @@ declare class httpCRs { static on(event: "close", callback: () => void): void; /** - * An event that is fired if there is an error receiving the response. The error event function receives an error object as parameter with a `code` field and a `message` field. After the error event the close even will also be triggered to conclude the HTTP request/response. + * An event that is fired if there is an error receiving the response. The error + * event function receives an error object as parameter with a `code` field and a + * `message` field. After the error event the close even will also be triggered to + * conclude the HTTP request/response. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_httpCRs_error @@ -2714,7 +3028,8 @@ declare class httpCRs { httpVersion: any; /** - * Return how many bytes are available to read. If there is a 'data' event handler, this will always return 0. + * Return how many bytes are available to read. If there is a 'data' event handler, + * this will always return 0. * @returns {number} How many bytes are available * @url http://www.espruino.com/Reference#l_httpCRs_available */ @@ -2740,12 +3055,12 @@ declare class httpCRs { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_httpCRs_pipe */ - pipe(destination: any, options: any): any; + pipe(destination: any, options: any): void; } /** - * This class provides functionality to recognise gestures drawn - * on a touchscreen. It is only built into Bangle.js 2. + * This class provides functionality to recognise gestures drawn on a touchscreen. + * It is only built into Bangle.js 2. * Usage: * ``` * var strokes = { @@ -2783,7 +3098,8 @@ declare class Unistroke { /** * The NRF class is for controlling functionality of the Nordic nRF51/nRF52 chips. - * Most functionality is related to Bluetooth Low Energy, however there are also some functions related to NFC that apply to NRF52-based devices. + * Most functionality is related to Bluetooth Low Energy, however there are also + * some functions related to NFC that apply to NRF52-based devices. * @url http://www.espruino.com/Reference#NRF */ declare class NRF { @@ -2805,7 +3121,7 @@ declare class NRF { * @param {any} options - Optional object containing options * @url http://www.espruino.com/Reference#l_NRF_setServices */ - static setServices(data: any, options: any): any; + static setServices(data: any, options: any): void; /** * @@ -2813,10 +3129,11 @@ declare class NRF { * @param {any} options - An optional object of options * @url http://www.espruino.com/Reference#l_NRF_setAdvertising */ - static setAdvertising(data: any, options: any): any; + static setAdvertising(data: any, options: any): void; /** - * Called when a host device connects to Espruino. The first argument contains the address. + * Called when a host device connects to Espruino. The first argument contains the + * address. * @param {string} event - The event to listen to. * @param {(addr: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `addr` The address of the device that has connected @@ -2847,10 +3164,9 @@ declare class NRF { static on(event: "security", callback: (status: any) => void): void; /** - * Called with a single byte value when Espruino is set up as - * a HID device and the computer it is connected to sends a - * HID report back to Espruino. This is usually used for handling - * indications such as the Caps Lock LED. + * Called with a single byte value when Espruino is set up as a HID device and the + * computer it is connected to sends a HID report back to Espruino. This is usually + * used for handling indications such as the Caps Lock LED. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_NRF_HID @@ -2890,9 +3206,9 @@ declare class NRF { static on(event: "NFCoff", callback: () => void): void; /** - * When NFC is started with `NRF.nfcStart`, this is fired - * when NFC data is received. It doesn't get called if - * NFC is started with `NRF.nfcURL` or `NRF.nfcRaw` + * When NFC is started with `NRF.nfcStart`, this is fired when NFC data is + * received. It doesn't get called if NFC is started with `NRF.nfcURL` or + * `NRF.nfcRaw` * @param {string} event - The event to listen to. * @param {(arr: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `arr` An ArrayBuffer containign the received data @@ -2904,43 +3220,43 @@ declare class NRF { * If a device is connected to Espruino, disconnect from it. * @url http://www.espruino.com/Reference#l_NRF_disconnect */ - static disconnect(): any; + static disconnect(): void; /** - * Disable Bluetooth advertising and disconnect from any device that - * connected to Puck.js as a peripheral (this won't affect any devices - * that Puck.js initiated connections to). + * Disable Bluetooth advertising and disconnect from any device that connected to + * Puck.js as a peripheral (this won't affect any devices that Puck.js initiated + * connections to). * This makes Puck.js undiscoverable, so it can't be connected to. * Use `NRF.wake()` to wake up and make Puck.js connectable again. * @url http://www.espruino.com/Reference#l_NRF_sleep */ - static sleep(): any; + static sleep(): void; /** - * Enable Bluetooth advertising (this is enabled by default), which - * allows other devices to discover and connect to Puck.js. + * Enable Bluetooth advertising (this is enabled by default), which allows other + * devices to discover and connect to Puck.js. * Use `NRF.sleep()` to disable advertising. * @url http://www.espruino.com/Reference#l_NRF_wake */ - static wake(): any; + static wake(): void; /** - * Restart the Bluetooth softdevice (if there is currently a BLE connection, - * it will queue a restart to be done when the connection closes). - * You shouldn't need to call this function in normal usage. However, Nordic's - * BLE softdevice has some settings that cannot be reset. For example there - * are only a certain number of unique UUIDs. Once these are all used the - * only option is to restart the softdevice to clear them all out. + * Restart the Bluetooth softdevice (if there is currently a BLE connection, it + * will queue a restart to be done when the connection closes). + * You shouldn't need to call this function in normal usage. However, Nordic's BLE + * softdevice has some settings that cannot be reset. For example there are only a + * certain number of unique UUIDs. Once these are all used the only option is to + * restart the softdevice to clear them all out. * * @param {any} callback - An optional function to be called while the softdevice is uninitialised. Use with caution - accessing console/bluetooth will almost certainly result in a crash. * @url http://www.espruino.com/Reference#l_NRF_restart */ - static restart(callback: any): any; + static restart(callback: any): void; /** * Get this device's default Bluetooth MAC address. - * For Puck.js, the last 5 characters of this (eg. `ee:ff`) - * are used in the device's advertised Bluetooth name. + * For Puck.js, the last 5 characters of this (eg. `ee:ff`) are used in the + * device's advertised Bluetooth name. * @returns {any} MAC address - a string of the form 'aa:bb:cc:dd:ee:ff' * @url http://www.espruino.com/Reference#l_NRF_getAddress */ @@ -2953,19 +3269,21 @@ declare class NRF { * ``` * Addresses take the form: * * `"ff:ee:dd:cc:bb:aa"` or `"ff:ee:dd:cc:bb:aa public"` for a public address - * * `"ff:ee:dd:cc:bb:aa random"` for a random static address (the default for Espruino) - * This may throw a `INVALID_BLE_ADDR` error if the upper two bits - * of the address don't match the address type. - * To change the address, Espruino must restart the softdevice. It will only do - * so when it is disconnected from other devices. + * * `"ff:ee:dd:cc:bb:aa random"` for a random static address (the default for + * Espruino) + * This may throw a `INVALID_BLE_ADDR` error if the upper two bits of the address + * don't match the address type. + * To change the address, Espruino must restart the softdevice. It will only do so + * when it is disconnected from other devices. * * @param {any} addr - The address to use (as a string) * @url http://www.espruino.com/Reference#l_NRF_setAddress */ - static setAddress(addr: any): any; + static setAddress(addr: any): void; /** - * Get the battery level in volts (the voltage that the NRF chip is running off of). + * Get the battery level in volts (the voltage that the NRF chip is running off + * of). * This is the battery level of the device itself - it has nothing to with any * device that might be connected. * @returns {number} Battery level in volts @@ -2975,8 +3293,9 @@ declare class NRF { /** * Change the data that Espruino advertises. - * Data can be of the form `{ UUID : data_as_byte_array }`. The UUID should be - * a [Bluetooth Service ID](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). + * Data can be of the form `{ UUID : data_as_byte_array }`. The UUID should be a + * [Bluetooth Service + * ID](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). * For example to return battery level at 95%, do: * ``` * NRF.setAdvertising({ @@ -2998,10 +3317,10 @@ declare class NRF { * 0x180D : undefined // Advertise service UUID 0x180D (HRM) * }); * ``` - * Service UUIDs can also be supplied in the second argument of - * `NRF.setServices`, but those go in the scan response packet. - * You can also supply the raw advertising data in an array. For example - * to advertise as an Eddystone beacon: + * Service UUIDs can also be supplied in the second argument of `NRF.setServices`, + * but those go in the scan response packet. + * You can also supply the raw advertising data in an array. For example to + * advertise as an Eddystone beacon: * ``` * NRF.setAdvertising([0x03, // Length of Service List * 0x03, // Param: Service List @@ -3015,15 +3334,16 @@ declare class NRF { * 'g','o','o','.','g','l','/','B','3','J','0','O','c'], * {interval:100}); * ``` - * (However for Eddystone we'd advise that you use the [Espruino Eddystone library](/Puck.js+Eddystone)) + * (However for Eddystone we'd advise that you use the [Espruino Eddystone + * library](/Puck.js+Eddystone)) * **Note:** When specifying data as an array, certain advertising options such as * `discoverable` and `showName` won't have any effect. - * **Note:** The size of Bluetooth LE advertising packets is limited to 31 bytes. If - * you want to advertise more data, consider using an array for `data` (See below), or - * `NRF.setScanResponse`. - * You can even specify an array of arrays or objects, in which case each advertising packet - * will be used in turn - for instance to make your device advertise battery level and its name - * as well as both Eddystone and iBeacon : + * **Note:** The size of Bluetooth LE advertising packets is limited to 31 bytes. + * If you want to advertise more data, consider using an array for `data` (See + * below), or `NRF.setScanResponse`. + * You can even specify an array of arrays or objects, in which case each + * advertising packet will be used in turn - for instance to make your device + * advertise battery level and its name as well as both Eddystone and iBeacon : * ``` * NRF.setAdvertising([ * {0x180F : [Puck.getBatteryPercentage()]}, // normal advertising, with battery % @@ -3045,21 +3365,21 @@ declare class NRF { * phy: "1mbps/2mbps/coded" // (NRF52840 only) use the long-range coded phy for transmission (1mbps default) * } * ``` - * Setting `connectable` and `scannable` to false gives the lowest power consumption - * as the BLE radio doesn't have to listen after sending advertising. - * **NOTE:** Non-`connectable` advertising can't have an advertising interval less than 100ms - * according to the BLE spec. - * So for instance to set the name of Puck.js without advertising any - * other data you can just use the command: + * Setting `connectable` and `scannable` to false gives the lowest power + * consumption as the BLE radio doesn't have to listen after sending advertising. + * **NOTE:** Non-`connectable` advertising can't have an advertising interval less + * than 100ms according to the BLE spec. + * So for instance to set the name of Puck.js without advertising any other data + * you can just use the command: * ``` * NRF.setAdvertising({},{name:"Hello"}); * ``` - * You can also specify 'manufacturer data', which is another form of advertising data. - * We've registered the Manufacturer ID 0x0590 (as Pur3 Ltd) for use with *Official - * Espruino devices* - use it to advertise whatever data you'd like, but we'd recommend - * using JSON. - * For example by not advertising a device name you can send up to 24 bytes of JSON on - * Espruino's manufacturer ID: + * You can also specify 'manufacturer data', which is another form of advertising + * data. We've registered the Manufacturer ID 0x0590 (as Pur3 Ltd) for use with + * *Official Espruino devices* - use it to advertise whatever data you'd like, but + * we'd recommend using JSON. + * For example by not advertising a device name you can send up to 24 bytes of JSON + * on Espruino's manufacturer ID: * ``` * var data = {a:1,b:2}; * NRF.setAdvertising({},{ @@ -3068,24 +3388,24 @@ declare class NRF { * manufacturerData:JSON.stringify(data) * }); * ``` - * If you're using [EspruinoHub](https://github.com/espruino/EspruinoHub) then it will - * automatically decode this into the folling MQTT topics: + * If you're using [EspruinoHub](https://github.com/espruino/EspruinoHub) then it + * will automatically decode this into the folling MQTT topics: * * `/ble/advertise/ma:c_:_a:dd:re:ss/espruino` -> `{"a":10,"b":15}` * * `/ble/advertise/ma:c_:_a:dd:re:ss/a` -> `1` * * `/ble/advertise/ma:c_:_a:dd:re:ss/b` -> `2` - * Note that **you only have 24 characters available for JSON**, so try to use - * the shortest field names possible and avoid floating point values that can - * be very long when converted to a String. + * Note that **you only have 24 characters available for JSON**, so try to use the + * shortest field names possible and avoid floating point values that can be very + * long when converted to a String. * * @param {any} data - The service data to advertise as an object - see below for more info * @param {any} options - An optional object of options * @url http://www.espruino.com/Reference#l_NRF_setAdvertising */ - static setAdvertising(data: any, options: any): any; + static setAdvertising(data: any, options: any): void; /** - * This is just like `NRF.setAdvertising`, except instead of advertising - * the data, it returns the packet that would be advertised as an array. + * This is just like `NRF.setAdvertising`, except instead of advertising the data, + * it returns the packet that would be advertised as an array. * * @param {any} data - The data to advertise as an object * @param {any} options - An optional object of options @@ -3095,26 +3415,28 @@ declare class NRF { static getAdvertisingData(data: any, options: any): any; /** - * The raw scan response data should be supplied as an array. For example to return "Sample" for the device name: + * The raw scan response data should be supplied as an array. For example to return + * "Sample" for the device name: * ``` * NRF.setScanResponse([0x07, // Length of Data * 0x09, // Param: Complete Local Name * 'S', 'a', 'm', 'p', 'l', 'e']); * ``` - * **Note:** `NRF.setServices(..., {advertise:[ ... ]})` writes advertised - * services into the scan response - so you can't use both `advertise` - * and `NRF.setServices` or one will overwrite the other. + * **Note:** `NRF.setServices(..., {advertise:[ ... ]})` writes advertised services + * into the scan response - so you can't use both `advertise` and `NRF.setServices` + * or one will overwrite the other. * * @param {any} data - The data to for the scan response * @url http://www.espruino.com/Reference#l_NRF_setScanResponse */ - static setScanResponse(data: any): any; + static setScanResponse(data: any): void; /** * Change the services and characteristics Espruino advertises. - * If you want to **change** the value of a characteristic, you need - * to use `NRF.updateServices()` instead - * To expose some information on Characteristic `ABCD` on service `BCDE` you could do: + * If you want to **change** the value of a characteristic, you need to use + * `NRF.updateServices()` instead + * To expose some information on Characteristic `ABCD` on service `BCDE` you could + * do: * ``` * NRF.setServices({ * 0xBCDE : { @@ -3179,8 +3501,8 @@ declare class NRF { * // more services allowed * }); * ``` - * **Note:** UUIDs can be integers between `0` and `0xFFFF`, strings of - * the form `"ABCD"`, or strings of the form `"ABCDABCD-ABCD-ABCD-ABCD-ABCDABCDABCD"` + * **Note:** UUIDs can be integers between `0` and `0xFFFF`, strings of the form + * `"ABCD"`, or strings of the form `"ABCDABCD-ABCD-ABCD-ABCD-ABCDABCDABCD"` * `options` can be of the form: * ``` * NRF.setServices(undefined, { @@ -3192,13 +3514,13 @@ declare class NRF { * }); * ``` * To enable BLE HID, you must set `hid` to an array which is the BLE report - * descriptor. The easiest way to do this is to use the `ble_hid_controls` - * or `ble_hid_keyboard` modules. - * **Note:** Just creating a service doesn't mean that the service will - * be advertised. It will only be available after a device connects. To - * advertise, specify the UUIDs you wish to advertise in the `advertise` - * field of the second `options` argument. For example this will create - * and advertise a heart rate service: + * descriptor. The easiest way to do this is to use the `ble_hid_controls` or + * `ble_hid_keyboard` modules. + * **Note:** Just creating a service doesn't mean that the service will be + * advertised. It will only be available after a device connects. To advertise, + * specify the UUIDs you wish to advertise in the `advertise` field of the second + * `options` argument. For example this will create and advertise a heart rate + * service: * ``` * NRF.setServices({ * 0x180D: { // heart_rate @@ -3211,29 +3533,31 @@ declare class NRF { * ``` * You may specify 128 bit UUIDs to advertise, however you may get a `DATA_SIZE` * exception because there is insufficient space in the Bluetooth LE advertising - * packet for the 128 bit UART UUID as well as the UUID you specified. In this - * case you can add `uart:false` after the `advertise` element to disable the - * UART, however you then be unable to connect to Puck.js's console via Bluetooth. + * packet for the 128 bit UART UUID as well as the UUID you specified. In this case + * you can add `uart:false` after the `advertise` element to disable the UART, + * however you then be unable to connect to Puck.js's console via Bluetooth. * If you absolutely require two or more 128 bit UUIDs then you will have to * specify your own raw advertising data packets with `NRF.setAdvertising` - * **Note:** The services on Espruino can only be modified when there is - * no device connected to it as it requires a restart of the Bluetooth stack. - * **iOS devices will 'cache' the list of services** so apps like - * NRF Connect may incorrectly display the old services even after you - * have modified them. To fix this, disable and re-enable Bluetooth on your - * iOS device, or use an Android device to run NRF Connect. - * **Note:** Not all combinations of security configuration values are valid, the valid combinations are: encrypted, - * encrypted + mitm, lesc, signed, signed + mitm. See `NRF.setSecurity` for more information. + * **Note:** The services on Espruino can only be modified when there is no device + * connected to it as it requires a restart of the Bluetooth stack. **iOS devices + * will 'cache' the list of services** so apps like NRF Connect may incorrectly + * display the old services even after you have modified them. To fix this, disable + * and re-enable Bluetooth on your iOS device, or use an Android device to run NRF + * Connect. + * **Note:** Not all combinations of security configuration values are valid, the + * valid combinations are: encrypted, encrypted + mitm, lesc, signed, signed + + * mitm. See `NRF.setSecurity` for more information. * * @param {any} data - The service (and characteristics) to advertise * @param {any} options - Optional object containing options * @url http://www.espruino.com/Reference#l_NRF_setServices */ - static setServices(data: any, options: any): any; + static setServices(data: any, options: any): void; /** - * Update values for the services and characteristics Espruino advertises. - * Only services and characteristics previously declared using `NRF.setServices` are affected. + * Update values for the services and characteristics Espruino advertises. Only + * services and characteristics previously declared using `NRF.setServices` are + * affected. * To update the '0xABCD' characteristic in the '0xBCDE' service: * ``` * NRF.updateServices({ @@ -3244,7 +3568,8 @@ declare class NRF { * } * }); * ``` - * You can also use 128 bit UUIDs, for example `"b7920001-3c1b-4b40-869f-3c0db9be80c6"`. + * You can also use 128 bit UUIDs, for example + * `"b7920001-3c1b-4b40-869f-3c0db9be80c6"`. * To define a service and characteristic and then notify connected clients of a * change to it when a button is pressed: * ``` @@ -3268,11 +3593,13 @@ declare class NRF { * }); * }, BTN, { repeat:true, edge:"rising", debounce: 50 }); * ``` - * This only works if the characteristic was created with `notify: true` using `NRF.setServices`, - * otherwise the characteristic will be updated but no notification will be sent. + * This only works if the characteristic was created with `notify: true` using + * `NRF.setServices`, otherwise the characteristic will be updated but no + * notification will be sent. * Also note that `maxLen` was specified. If it wasn't then the maximum length of * the characteristic would have been 5 - the length of `"Hello"`. - * To indicate (i.e. notify with ACK) connected clients of a change to the '0xABCD' characteristic in the '0xBCDE' service: + * To indicate (i.e. notify with ACK) connected clients of a change to the '0xABCD' + * characteristic in the '0xBCDE' service: * ``` * NRF.updateServices({ * 0xBCDE : { @@ -3283,19 +3610,20 @@ declare class NRF { * } * }); * ``` - * This only works if the characteristic was created with `indicate: true` using `NRF.setServices`, - * otherwise the characteristic will be updated but no notification will be sent. + * This only works if the characteristic was created with `indicate: true` using + * `NRF.setServices`, otherwise the characteristic will be updated but no + * notification will be sent. * **Note:** See `NRF.setServices` for more information * * @param {any} data - The service (and characteristics) to update * @url http://www.espruino.com/Reference#l_NRF_updateServices */ - static updateServices(data: any): any; + static updateServices(data: any): void; /** * Start/stop listening for BLE advertising packets within range. Returns a - * `BluetoothDevice` for each advertsing packet. **By default this is not an active scan, so - * Scan Response advertising data is not included (see below)** + * `BluetoothDevice` for each advertsing packet. **By default this is not an active + * scan, so Scan Response advertising data is not included (see below)** * ``` * // Start scanning * packets=10; @@ -3320,42 +3648,43 @@ declare class NRF { * "name": "DeviceName" // the advertised device name * } * ``` - * You can also supply a set of filters (as described in `NRF.requestDevice`) as a second argument, which will - * allow you to filter the devices you get a callback for. This helps - * to cut down on the time spent processing JavaScript code in areas with - * a lot of Bluetooth advertisements. For example to find only devices + * You can also supply a set of filters (as described in `NRF.requestDevice`) as a + * second argument, which will allow you to filter the devices you get a callback + * for. This helps to cut down on the time spent processing JavaScript code in + * areas with a lot of Bluetooth advertisements. For example to find only devices * with the manufacturer data `0x0590` (Espruino's ID) you could do: * ``` * NRF.setScan(function(d) { * console.log(d.manufacturerData); * }, { filters: [{ manufacturerData:{0x0590:{}} }] }); * ``` - * You can also specify `active:true` in the second argument to perform - * active scanning (this requests scan response packets) from any - * devices it finds. - * **Note:** Using a filter in `setScan` filters each advertising packet individually. As - * a result, if you filter based on a service UUID and a device advertises with multiple packets - * (or a scan response when `active:true`) only the packets matching the filter are returned. To - * aggregate multiple packets you can use `NRF.findDevices`. - * **Note:** BLE advertising packets can arrive quickly - faster than you'll - * be able to print them to the console. It's best only to print a few, or - * to use a function like `NRF.findDevices(..)` which will collate a list - * of available devices. - * **Note:** Using setScan turns the radio's receive mode on constantly. This - * can draw a *lot* of power (12mA or so), so you should use it sparingly or - * you can run your battery down quickly. + * You can also specify `active:true` in the second argument to perform active + * scanning (this requests scan response packets) from any devices it finds. + * **Note:** Using a filter in `setScan` filters each advertising packet + * individually. As a result, if you filter based on a service UUID and a device + * advertises with multiple packets (or a scan response when `active:true`) only + * the packets matching the filter are returned. To aggregate multiple packets you + * can use `NRF.findDevices`. + * **Note:** BLE advertising packets can arrive quickly - faster than you'll be + * able to print them to the console. It's best only to print a few, or to use a + * function like `NRF.findDevices(..)` which will collate a list of available + * devices. + * **Note:** Using setScan turns the radio's receive mode on constantly. This can + * draw a *lot* of power (12mA or so), so you should use it sparingly or you can + * run your battery down quickly. * * @param {any} callback - The callback to call with received advertising packets, or undefined to stop * @param {any} options - An optional object `{filters: ...}` (as would be passed to `NRF.requestDevice`) to filter devices by * @url http://www.espruino.com/Reference#l_NRF_setScan */ - static setScan(callback: any, options: any): any; + static setScan(callback: any, options: any): void; /** * This function can be used to quickly filter through Bluetooth devices. - * For instance if you wish to scan for multiple different types of device at the same time - * then you could use `NRF.findDevices` with all the filters you're interested in. When scanning - * is finished you can then use `NRF.filterDevices` to pick out just the devices of interest. + * For instance if you wish to scan for multiple different types of device at the + * same time then you could use `NRF.findDevices` with all the filters you're + * interested in. When scanning is finished you can then use `NRF.filterDevices` to + * pick out just the devices of interest. * ``` * // the two types of device we're interested in * var filter1 = [{serviceData:{"fe95":{}}}]; @@ -3378,8 +3707,8 @@ declare class NRF { static filterDevices(devices: any, filters: any): any; /** - * Utility function to return a list of BLE devices detected in range. Behind the scenes, - * this uses `NRF.setScan(...)` and collates the results. + * Utility function to return a list of BLE devices detected in range. Behind the + * scenes, this uses `NRF.setScan(...)` and collates the results. * ``` * NRF.findDevices(function(devices) { * console.log(devices); @@ -3407,22 +3736,27 @@ declare class NRF { * ] * ``` * For more information on the structure returned, see `NRF.setScan`. - * If you want to scan only for specific devices you can replace the timeout with an object - * of the form `{filters: ..., timeout : ..., active: bool}` using the filters - * described in `NRF.requestDevice`. For example to search for devices with Espruino's `manufacturerData`: + * If you want to scan only for specific devices you can replace the timeout with + * an object of the form `{filters: ..., timeout : ..., active: bool}` using the + * filters described in `NRF.requestDevice`. For example to search for devices with + * Espruino's `manufacturerData`: * ``` * NRF.findDevices(function(devices) { * ... * }, {timeout : 2000, filters : [{ manufacturerData:{0x0590:{}} }] }); * ``` - * You could then use [`BluetoothDevice.gatt.connect(...)`](/Reference#l_BluetoothRemoteGATTServer_connect) on - * the device returned to make a connection. - * You can also use [`NRF.connect(...)`](/Reference#l_NRF_connect) on just the `id` string returned, which - * may be useful if you always want to connect to a specific device. - * **Note:** Using findDevices turns the radio's receive mode on for 2000ms (or however long you specify). This - * can draw a *lot* of power (12mA or so), so you should use it sparingly or you can run your battery down quickly. - * **Note:** The 'data' field contains the data of *the last packet received*. There may have been more - * packets. To get data for each packet individually use `NRF.setScan` instead. + * You could then use + * [`BluetoothDevice.gatt.connect(...)`](/Reference#l_BluetoothRemoteGATTServer_connect) + * on the device returned to make a connection. + * You can also use [`NRF.connect(...)`](/Reference#l_NRF_connect) on just the `id` + * string returned, which may be useful if you always want to connect to a specific + * device. + * **Note:** Using findDevices turns the radio's receive mode on for 2000ms (or + * however long you specify). This can draw a *lot* of power (12mA or so), so you + * should use it sparingly or you can run your battery down quickly. + * **Note:** The 'data' field contains the data of *the last packet received*. + * There may have been more packets. To get data for each packet individually use + * `NRF.setScan` instead. * * @param {any} callback - The callback to call with received advertising packets (as `BluetoothDevice`), or undefined to stop * @param {any} [options] - [optional] A time in milliseconds to scan for (defaults to 2000), Or an optional object `{filters: ..., timeout : ..., active: bool}` (as would be passed to `NRF.requestDevice`) to filter devices by @@ -3431,8 +3765,8 @@ declare class NRF { static findDevices(callback: (devices: BluetoothDevice[]) => void, options?: number | { filters?: NRFFilters, timeout?: number, active?: boolean }): void; /** - * Start/stop listening for RSSI values on the currently active connection - * (where This device is a peripheral and is being connected to by a 'central' device) + * Start/stop listening for RSSI values on the currently active connection (where + * This device is a peripheral and is being connected to by a 'central' device) * ``` * // Start scanning * NRF.setRSSIHandler(function(rssi) { @@ -3446,7 +3780,7 @@ declare class NRF { * @param {any} callback - The callback to call with the RSSI value, or undefined to stop * @url http://www.espruino.com/Reference#l_NRF_setRSSIHandler */ - static setRSSIHandler(callback: any): any; + static setRSSIHandler(callback: any): void; /** * Set the BLE radio transmit power. The default TX power is 0 dBm, and @@ -3454,26 +3788,25 @@ declare class NRF { * @param {number} power - Transmit power. Accepted values are -40(nRF52 only), -30(nRF51 only), -20, -16, -12, -8, -4, 0, and 4 dBm. On nRF52840 (eg Bangle.js 2) 5/6/7/8 dBm are available too. Others will give an error code. * @url http://www.espruino.com/Reference#l_NRF_setTxPower */ - static setTxPower(power: number): any; + static setTxPower(power: number): void; /** - * **THIS IS DEPRECATED** - please use `NRF.setConnectionInterval` for - * peripheral and `NRF.connect(addr, options)`/`BluetoothRemoteGATTServer.connect(options)` + * **THIS IS DEPRECATED** - please use `NRF.setConnectionInterval` for peripheral + * and `NRF.connect(addr, options)`/`BluetoothRemoteGATTServer.connect(options)` * for central connections. - * This sets the connection parameters - these affect the transfer speed and - * power usage when the device is connected. + * This sets the connection parameters - these affect the transfer speed and power + * usage when the device is connected. * * When not low power, the connection interval is between 7.5 and 20ms * * When low power, the connection interval is between 500 and 1000ms - * When low power connection is enabled, transfers of data over Bluetooth - * will be very slow, however power usage while connected will be drastically - * decreased. + * When low power connection is enabled, transfers of data over Bluetooth will be + * very slow, however power usage while connected will be drastically decreased. * This will only take effect after the connection is disconnected and * re-established. * * @param {boolean} lowPower - Whether the connection is low power or not * @url http://www.espruino.com/Reference#l_NRF_setLowPowerConnection */ - static setLowPowerConnection(lowPower: boolean): any; + static setLowPowerConnection(lowPower: boolean): void; /** * Enables NFC and starts advertising the given URL. For example: @@ -3484,12 +3817,12 @@ declare class NRF { * @param {any} url - The URL string to expose on NFC, or `undefined` to disable NFC * @url http://www.espruino.com/Reference#l_NRF_nfcURL */ - static nfcURL(url: any): any; + static nfcURL(url: any): void; /** * Enables NFC and with an out of band 16 byte pairing key. - * For example the following will enable out of band pairing on BLE - * such that the device will pair when you tap the phone against it: + * For example the following will enable out of band pairing on BLE such that the + * device will pair when you tap the phone against it: * ``` * var bleKey = [0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF, 0x99, 0x88, 0x77, 0x66, 0x55, 0x44, 0x33, 0x22, 0x11, 0x00]; * NRF.on('security',s=>print("security",JSON.stringify(s))); @@ -3500,7 +3833,7 @@ declare class NRF { * @param {any} key - 16 byte out of band key * @url http://www.espruino.com/Reference#l_NRF_nfcPair */ - static nfcPair(key: any): any; + static nfcPair(key: any): void; /** * Enables NFC with a record that will launch the given android app. @@ -3512,7 +3845,7 @@ declare class NRF { * @param {any} app - The unique identifier of the given Android App * @url http://www.espruino.com/Reference#l_NRF_nfcAndroidApp */ - static nfcAndroidApp(app: any): any; + static nfcAndroidApp(app: any): void; /** * Enables NFC and starts advertising with Raw data. For example: @@ -3524,12 +3857,13 @@ declare class NRF { * @param {any} payload - The NFC NDEF message to deliver to the reader * @url http://www.espruino.com/Reference#l_NRF_nfcRaw */ - static nfcRaw(payload: any): any; + static nfcRaw(payload: any): void; /** - * **Advanced NFC Functionality.** If you just want to advertise a URL, use `NRF.nfcURL` instead. - * Enables NFC and starts advertising. `NFCrx` events will be - * fired when data is received. + * **Advanced NFC Functionality.** If you just want to advertise a URL, use + * `NRF.nfcURL` instead. + * Enables NFC and starts advertising. `NFCrx` events will be fired when data is + * received. * ``` * NRF.nfcStart(); * ``` @@ -3541,7 +3875,8 @@ declare class NRF { static nfcStart(payload: any): any; /** - * **Advanced NFC Functionality.** If you just want to advertise a URL, use `NRF.nfcURL` instead. + * **Advanced NFC Functionality.** If you just want to advertise a URL, use + * `NRF.nfcURL` instead. * Disables NFC. * ``` * NRF.nfcStop(); @@ -3549,14 +3884,15 @@ declare class NRF { * * @url http://www.espruino.com/Reference#l_NRF_nfcStop */ - static nfcStop(): any; + static nfcStop(): void; /** - * **Advanced NFC Functionality.** If you just want to advertise a URL, use `NRF.nfcURL` instead. - * Acknowledges the last frame and optionally transmits a response. - * If payload is an array, then a array.length byte nfc frame is sent. - * If payload is a int, then a 4bit ACK/NACK is sent. - * **Note:** ```nfcSend``` should always be called after an ```NFCrx``` event. + * **Advanced NFC Functionality.** If you just want to advertise a URL, use + * `NRF.nfcURL` instead. + * Acknowledges the last frame and optionally transmits a response. If payload is + * an array, then a array.length byte nfc frame is sent. If payload is a int, then + * a 4bit ACK/NACK is sent. **Note:** ```nfcSend``` should always be called after + * an ```NFCrx``` event. * ``` * NRF.nfcSend(new Uint8Array([0x01, 0x02, ...])); * // or @@ -3568,19 +3904,21 @@ declare class NRF { * @param {any} payload - Optional tx data * @url http://www.espruino.com/Reference#l_NRF_nfcSend */ - static nfcSend(payload: any): any; + static nfcSend(payload: any): void; /** - * Send a USB HID report. HID must first be enabled with `NRF.setServices({}, {hid: hid_report})` + * Send a USB HID report. HID must first be enabled with `NRF.setServices({}, {hid: + * hid_report})` * * @param {any} data - Input report data as an array * @param {any} callback - A callback function to be called when the data is sent * @url http://www.espruino.com/Reference#l_NRF_sendHIDReport */ - static sendHIDReport(data: any, callback: any): any; + static sendHIDReport(data: any, callback: any): void; /** - * Check if Apple Notification Center Service (ANCS) is currently active on the BLE connection + * Check if Apple Notification Center Service (ANCS) is currently active on the BLE + * connection * * @returns {boolean} True if Apple Notification Center Service (ANCS) has been initialised and is active * @url http://www.espruino.com/Reference#l_NRF_ancsIsActive @@ -3588,13 +3926,14 @@ declare class NRF { static ancsIsActive(): boolean; /** - * Send an ANCS action for a specific Notification UID. Corresponds to posaction/negaction in the 'ANCS' event that was received + * Send an ANCS action for a specific Notification UID. Corresponds to + * posaction/negaction in the 'ANCS' event that was received * * @param {number} uid - The UID of the notification to respond to * @param {boolean} positive - `true` for positive action, `false` for negative * @url http://www.espruino.com/Reference#l_NRF_ancsAction */ - static ancsAction(uid: number, positive: boolean): any; + static ancsAction(uid: number, positive: boolean): void; /** * Get ANCS info for a notification, eg: @@ -3603,7 +3942,7 @@ declare class NRF { * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_NRF_ancsGetNotificationInfo */ - static ancsGetNotificationInfo(uid: number): Promise; + static ancsGetNotificationInfo(uid: number): Promise; /** * Get ANCS info for an app (add id is available via `ancsGetNotificationInfo`) @@ -3627,7 +3966,7 @@ declare class NRF { * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_NRF_ancsGetAppInfo */ - static ancsGetAppInfo(id: any): Promise; + static ancsGetAppInfo(id: any): Promise; /** * Check if Apple Media Service (AMS) is currently active on the BLE connection @@ -3638,21 +3977,24 @@ declare class NRF { static amsIsActive(): boolean; /** - * Get Apple Media Service (AMS) info for the current media player. - * "playbackinfo" returns a concatenation of three comma-separated values: - * - PlaybackState: a string that represents the integer value of the playback state: + * Get Apple Media Service (AMS) info for the current media player. "playbackinfo" + * returns a concatenation of three comma-separated values: + * - PlaybackState: a string that represents the integer value of the playback + * state: * - PlaybackStatePaused = 0 * - PlaybackStatePlaying = 1 * - PlaybackStateRewinding = 2 * - PlaybackStateFastForwarding = 3 - * - PlaybackRate: a string that represents the floating point value of the playback rate. - * - ElapsedTime: a string that represents the floating point value of the elapsed time of the current track, in seconds + * - PlaybackRate: a string that represents the floating point value of the + * playback rate. + * - ElapsedTime: a string that represents the floating point value of the elapsed + * time of the current track, in seconds * * @param {any} id - Either 'name', 'playbackinfo' or 'volume' * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_NRF_amsGetPlayerInfo */ - static amsGetPlayerInfo(id: any): Promise; + static amsGetPlayerInfo(id: any): Promise; /** * Get Apple Media Service (AMS) info for the currently-playing track @@ -3661,36 +4003,47 @@ declare class NRF { * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_NRF_amsGetTrackInfo */ - static amsGetTrackInfo(id: any): Promise; + static amsGetTrackInfo(id: any): Promise; /** * Send an AMS command to an Apple Media Service device to control music playback - * Command is one of play, pause, playpause, next, prev, volup, voldown, repeat, shuffle, skipforward, skipback, like, dislike, bookmark + * Command is one of play, pause, playpause, next, prev, volup, voldown, repeat, + * shuffle, skipforward, skipback, like, dislike, bookmark * * @param {any} id - For example, 'play', 'pause', 'volup' or 'voldown' * @url http://www.espruino.com/Reference#l_NRF_amsCommand */ - static amsCommand(id: any): any; + static amsCommand(id: any): void; /** - * Search for available devices matching the given filters. Since we have no UI here, - * Espruino will pick the FIRST device it finds, or it'll call `catch`. + * Search for available devices matching the given filters. Since we have no UI + * here, Espruino will pick the FIRST device it finds, or it'll call `catch`. * `options` can have the following fields: - * * `filters` - a list of filters that a device must match before it is returned (see below) - * * `timeout` - the maximum time to scan for in milliseconds (scanning stops when a match - * is found. eg. `NRF.requestDevice({ timeout:2000, filters: [ ... ] })` - * * `active` - whether to perform active scanning (requesting 'scan response' packets from any - * devices that are found). eg. `NRF.requestDevice({ active:true, filters: [ ... ] })` - * * `phy` - (NRF52840 only) use the long-range coded phy (`"1mbps"` default, can be `"1mbps/2mbps/both/coded"`) - * * `extended` - (NRF52840 only) support receiving extended-length advertising packets (default=true if phy isn't `"1mbps"`) + * * `filters` - a list of filters that a device must match before it is returned + * (see below) + * * `timeout` - the maximum time to scan for in milliseconds (scanning stops when + * a match is found. eg. `NRF.requestDevice({ timeout:2000, filters: [ ... ] })` + * * `active` - whether to perform active scanning (requesting 'scan response' + * packets from any devices that are found). eg. `NRF.requestDevice({ active:true, + * filters: [ ... ] })` + * * `phy` - (NRF52840 only) use the long-range coded phy (`"1mbps"` default, can + * be `"1mbps/2mbps/both/coded"`) + * * `extended` - (NRF52840 only) support receiving extended-length advertising + * packets (default=true if phy isn't `"1mbps"`) * **NOTE:** `timeout` and `active` are not part of the Web Bluetooth standard. * The following filter types are implemented: - * * `services` - list of services as strings (all of which must match). 128 bit services must be in the form '01230123-0123-0123-0123-012301230123' + * * `services` - list of services as strings (all of which must match). 128 bit + * services must be in the form '01230123-0123-0123-0123-012301230123' * * `name` - exact device name * * `namePrefix` - starting characters of device name - * * `id` - exact device address (`id:"e9:53:86:09:89:99 random"`) (this is Espruino-specific, and is not part of the Web Bluetooth spec) - * * `serviceData` - an object containing service characteristics which must all match (`serviceData:{"1809":{}}`). Matching of actual service data is not supported yet. - * * `manufacturerData` - an object containing manufacturer UUIDs which must all match (`manufacturerData:{0x0590:{}}`). Matching of actual manufacturer data is not supported yet. + * * `id` - exact device address (`id:"e9:53:86:09:89:99 random"`) (this is + * Espruino-specific, and is not part of the Web Bluetooth spec) + * * `serviceData` - an object containing service characteristics which must all + * match (`serviceData:{"1809":{}}`). Matching of actual service data is not + * supported yet. + * * `manufacturerData` - an object containing manufacturer UUIDs which must all + * match (`manufacturerData:{0x0590:{}}`). Matching of actual manufacturer data + * is not supported yet. * ``` * NRF.requestDevice({ filters: [{ namePrefix: 'Puck.js' }] }).then(function(device) { ... }); * // or @@ -3727,11 +4080,13 @@ declare class NRF { * ``` * Note that you have to keep track of the `gatt` variable so that you can * disconnect the Bluetooth connection when you're done. - * **Note:** Using a filter in `NRF.requestDevice` filters each advertising packet individually. As - * soon as a matching advertisement is received, `NRF.requestDevice` resolves the promise and stops - * scanning. This means that if you filter based on a service UUID and a device advertises with multiple packets - * (or a scan response when `active:true`) only the packet matching the filter is returned - you may not - * get the device's name is that was in a separate packet. To aggregate multiple packets you can use `NRF.findDevices`. + * **Note:** Using a filter in `NRF.requestDevice` filters each advertising packet + * individually. As soon as a matching advertisement is received, + * `NRF.requestDevice` resolves the promise and stops scanning. This means that if + * you filter based on a service UUID and a device advertises with multiple packets + * (or a scan response when `active:true`) only the packet matching the filter is + * returned - you may not get the device's name is that was in a separate packet. + * To aggregate multiple packets you can use `NRF.findDevices`. * * @param {any} options - Options used to filter the device to use * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete @@ -3740,16 +4095,18 @@ declare class NRF { static requestDevice(options?: { filters?: NRFFilters, timeout?: number, active?: boolean, phy?: string, extended?: boolean }): Promise; /** - * Connect to a BLE device by MAC address. Returns a promise, - * the argument of which is the `BluetoothRemoteGATTServer` connection. + * Connect to a BLE device by MAC address. Returns a promise, the argument of which + * is the `BluetoothRemoteGATTServer` connection. * ``` * NRF.connect("aa:bb:cc:dd:ee").then(function(server) { * // ... * }); * ``` - * This has the same effect as calling `BluetoothDevice.gatt.connect` on a `BluetoothDevice` requested - * using `NRF.requestDevice`. It just allows you to specify the address directly (without having to scan). - * You can use it as follows - this would connect to another Puck device and turn its LED on: + * This has the same effect as calling `BluetoothDevice.gatt.connect` on a + * `BluetoothDevice` requested using `NRF.requestDevice`. It just allows you to + * specify the address directly (without having to scan). + * You can use it as follows - this would connect to another Puck device and turn + * its LED on: * ``` * var gatt; * NRF.connect("aa:bb:cc:dd:ee random").then(function(g) { @@ -3764,59 +4121,62 @@ declare class NRF { * console.log("Done!"); * }); * ``` - * **Note:** Espruino Bluetooth devices use a type of BLE address known as 'random static', - * which is different to a 'public' address. To connect to an Espruino device you'll need - * to use an address string of the form `"aa:bb:cc:dd:ee random"` rather than just - * `"aa:bb:cc:dd:ee"`. If you scan for devices with `NRF.findDevices`/`NRF.setScan` then - * addresses are already reported in the correct format. + * **Note:** Espruino Bluetooth devices use a type of BLE address known as 'random + * static', which is different to a 'public' address. To connect to an Espruino + * device you'll need to use an address string of the form `"aa:bb:cc:dd:ee + * random"` rather than just `"aa:bb:cc:dd:ee"`. If you scan for devices with + * `NRF.findDevices`/`NRF.setScan` then addresses are already reported in the + * correct format. * * @param {any} mac - The MAC address to connect to * @param {any} options - (Espruino-specific) An object of connection options (see `BluetoothRemoteGATTServer.connect` for full details) * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_NRF_connect */ - static connect(mac: any, options: any): Promise; + static connect(mac: any, options: any): Promise; /** - * If set to true, whenever a device bonds it will be added to the - * whitelist. - * When set to false, the whitelist is cleared and newly bonded - * devices will not be added to the whitelist. - * **Note:** This is remembered between `reset()`s but isn't - * remembered after power-on (you'll have to add it to `onInit()`. + * If set to true, whenever a device bonds it will be added to the whitelist. + * When set to false, the whitelist is cleared and newly bonded devices will not be + * added to the whitelist. + * **Note:** This is remembered between `reset()`s but isn't remembered after + * power-on (you'll have to add it to `onInit()`. * * @param {boolean} whitelisting - Are we using a whitelist? (default false) * @url http://www.espruino.com/Reference#l_NRF_setWhitelist */ - static setWhitelist(whitelisting: boolean): any; + static setWhitelist(whitelisting: boolean): void; /** - * When connected, Bluetooth LE devices communicate at a set interval. - * Lowering the interval (eg. more packets/second) means a lower delay when - * sending data, higher bandwidth, but also more power consumption. + * When connected, Bluetooth LE devices communicate at a set interval. Lowering the + * interval (eg. more packets/second) means a lower delay when sending data, higher + * bandwidth, but also more power consumption. * By default, when connected as a peripheral Espruino automatically adjusts the - * connection interval. When connected it's as fast as possible (7.5ms) but when idle - * for over a minute it drops to 200ms. On continued activity (>1 BLE operation) the - * interval is raised to 7.5ms again. + * connection interval. When connected it's as fast as possible (7.5ms) but when + * idle for over a minute it drops to 200ms. On continued activity (>1 BLE + * operation) the interval is raised to 7.5ms again. * The options for `interval` are: * * `undefined` / `"auto"` : (default) automatically adjust connection interval - * * `100` : set min and max connection interval to the same number (between 7.5ms and 4000ms) - * * `{minInterval:20, maxInterval:100}` : set min and max connection interval as a range - * This configuration is not remembered during a `save()` - you will have to - * re-set it via `onInit`. - * **Note:** If connecting to another device (as Central), you can use - * an extra argument to `NRF.connect` or `BluetoothRemoteGATTServer.connect` - * to specify a connection interval. - * **Note:** This overwrites any changes imposed by the deprecated `NRF.setLowPowerConnection` + * * `100` : set min and max connection interval to the same number (between 7.5ms + * and 4000ms) + * * `{minInterval:20, maxInterval:100}` : set min and max connection interval as a + * range + * This configuration is not remembered during a `save()` - you will have to re-set + * it via `onInit`. + * **Note:** If connecting to another device (as Central), you can use an extra + * argument to `NRF.connect` or `BluetoothRemoteGATTServer.connect` to specify a + * connection interval. + * **Note:** This overwrites any changes imposed by the deprecated + * `NRF.setLowPowerConnection` * * @param {any} interval - The connection interval to use (see below) * @url http://www.espruino.com/Reference#l_NRF_setConnectionInterval */ - static setConnectionInterval(interval: any): any; + static setConnectionInterval(interval: any): void; /** - * Sets the security options used when connecting/pairing. This applies to both central - * *and* peripheral mode. + * Sets the security options used when connecting/pairing. This applies to both + * central *and* peripheral mode. * ``` * NRF.setSecurity({ * display : bool // default false, can this device display a passkey @@ -3836,20 +4196,19 @@ declare class NRF { * ``` * **NOTE:** Some combinations of arguments will cause an error. For example * supplying a passkey without `display:1` is not allowed. If `display:1` is set - * you do not require a physical display, the user just needs to know - * the passkey you supplied. + * you do not require a physical display, the user just needs to know the passkey + * you supplied. * For instance, to require pairing and to specify a passkey, use: * ``` * NRF.setSecurity({passkey:"123456", mitm:1, display:1}); * ``` - * However, while most devices will request a passkey for pairing at - * this point it is still possible for a device to connect without - * requiring one (eg. using the 'NRF Connect' app). - * To force a passkey you need to protect each characteristic - * you define with `NRF.setSecurity`. For instance the following - * code will *require* that the passkey `123456` is entered - * before the characteristic `9d020002-bf5f-1d1a-b52a-fe52091d5b12` - * can be read. + * However, while most devices will request a passkey for pairing at this point it + * is still possible for a device to connect without requiring one (eg. using the + * 'NRF Connect' app). + * To force a passkey you need to protect each characteristic you define with + * `NRF.setSecurity`. For instance the following code will *require* that the + * passkey `123456` is entered before the characteristic + * `9d020002-bf5f-1d1a-b52a-fe52091d5b12` can be read. * ``` * NRF.setSecurity({passkey:"123456", mitm:1, display:1}); * NRF.setServices({ @@ -3888,17 +4247,18 @@ declare class NRF { * } * }); * ``` - * **Note:** If `passkey` or `oob` is specified, the Nordic UART service (if enabled) - * will automatically be set to require encryption, but otherwise it is open. + * **Note:** If `passkey` or `oob` is specified, the Nordic UART service (if + * enabled) will automatically be set to require encryption, but otherwise it is + * open. * * @param {any} options - An object containing security-related options (see below) * @url http://www.espruino.com/Reference#l_NRF_setSecurity */ - static setSecurity(options: any): any; + static setSecurity(options: any): void; /** - * Return an object with information about the security - * state of the current peripheral connection: + * Return an object with information about the security state of the current + * peripheral connection: * ``` * { * connected // The connection is active (not disconnected). @@ -3933,13 +4293,14 @@ declare class Bluetooth { /** * @url http://www.espruino.com/Reference#l_Bluetooth_setConsole */ - static setConsole(): any; + static setConsole(): void; } /** - * A Web Bluetooth-style device - you can request one using `NRF.requestDevice(address)` + * A Web Bluetooth-style device - you can request one using + * `NRF.requestDevice(address)` * For example: * ``` * var gatt; @@ -3962,8 +4323,8 @@ declare class Bluetooth { declare class BluetoothDevice { /** * Called when the device gets disconnected. - * To connect and then print `Disconnected` when the device is - * disconnected, just do the following: + * To connect and then print `Disconnected` when the device is disconnected, just + * do the following: * ``` * var gatt; * NRF.connect("aa:bb:cc:dd:ee:ff").then(function(gatt) { @@ -3990,7 +4351,8 @@ declare class BluetoothDevice { /** * Called when the device pairs and sends a passkey that Espruino should display. - * For this to be used, you'll have to specify that there's a display using `NRF.setSecurity` + * For this to be used, you'll have to specify that there's a display using + * `NRF.setSecurity` * **This is not part of the Web Bluetooth Specification.** It has been added * specifically for Espruino. * @param {string} event - The event to listen to. @@ -4001,9 +4363,12 @@ declare class BluetoothDevice { static on(event: "passkey", callback: (passkey: any) => void): void; /** - * Called when the device pairs, displays a passkey, and wants Espruino to tell it what the passkey was. - * Respond with `BluetoothDevice.sendPasskey()` with a 6 character string containing only `0..9`. - * For this to be used, you'll have to specify that there's a keyboard using `NRF.setSecurity` + * Called when the device pairs, displays a passkey, and wants Espruino to tell it + * what the passkey was. + * Respond with `BluetoothDevice.sendPasskey()` with a 6 character string + * containing only `0..9`. + * For this to be used, you'll have to specify that there's a keyboard using + * `NRF.setSecurity` * **This is not part of the Web Bluetooth Specification.** It has been added * specifically for Espruino. * @param {string} event - The event to listen to. @@ -4025,19 +4390,20 @@ declare class BluetoothDevice { rssi: boolean; /** - * To be used as a response when the event `BluetoothDevice.sendPasskey` has been received. + * To be used as a response when the event `BluetoothDevice.sendPasskey` has been + * received. * **This is not part of the Web Bluetooth Specification.** It has been added * specifically for Espruino. * * @param {any} passkey - A 6 character numeric String to be returned to the device * @url http://www.espruino.com/Reference#l_BluetoothDevice_sendPasskey */ - sendPasskey(passkey: any): any; + sendPasskey(passkey: any): void; } /** - * Web Bluetooth-style GATT server - get this using `NRF.connect(address)` - * or `NRF.requestDevice(options)` and `response.gatt.connect` + * Web Bluetooth-style GATT server - get this using `NRF.connect(address)` or + * `NRF.requestDevice(options)` and `response.gatt.connect` * https://webbluetoothcg.github.io/web-bluetooth/#bluetoothremotegattserver * @url http://www.espruino.com/Reference#BluetoothRemoteGATTServer */ @@ -4045,8 +4411,8 @@ declare class BluetoothRemoteGATTServer { /** - * Connect to a BLE device - returns a promise, - * the argument of which is the `BluetoothRemoteGATTServer` connection. + * Connect to a BLE device - returns a promise, the argument of which is the + * `BluetoothRemoteGATTServer` connection. * See [`NRF.requestDevice`](/Reference#l_NRF_requestDevice) for usage examples. * `options` is an optional object containing: * ``` @@ -4055,26 +4421,27 @@ declare class BluetoothRemoteGATTServer { * maxInterval // max connection interval in milliseconds, 7.5 ms to 4 s * } * ``` - * By default the interval is 20-200ms (or 500-1000ms if `NRF.setLowPowerConnection(true)` was called. - * During connection Espruino negotiates with the other device to find a common interval that can be - * used. + * By default the interval is 20-200ms (or 500-1000ms if + * `NRF.setLowPowerConnection(true)` was called. During connection Espruino + * negotiates with the other device to find a common interval that can be used. * For instance calling: * ``` * NRF.requestDevice({ filters: [{ namePrefix: 'Pixl.js' }] }).then(function(device) { * return device.gatt.connect({minInterval:7.5, maxInterval:7.5}); * }).then(function(g) { * ``` - * will force the connection to use the fastest connection interval possible (as long as the device - * at the other end supports it). - * **Note:** The Web Bluetooth spec states that if a device hasn't advertised its name, when connected - * to a device the central (in this case Espruino) should automatically retrieve the name from the - * corresponding characteristic (`0x2a00` on service `0x1800`). Espruino does not automatically do this. + * will force the connection to use the fastest connection interval possible (as + * long as the device at the other end supports it). + * **Note:** The Web Bluetooth spec states that if a device hasn't advertised its + * name, when connected to a device the central (in this case Espruino) should + * automatically retrieve the name from the corresponding characteristic (`0x2a00` + * on service `0x1800`). Espruino does not automatically do this. * * @param {any} options - (Espruino-specific) An object of connection options (see below) * @returns {any} A `Promise` that is resolved (or rejected) when the connection is complete * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_connect */ - connect(options: any): Promise; + connect(options: any): Promise; /** * @returns {boolean} Whether the device is connected or not @@ -4090,20 +4457,20 @@ declare class BluetoothRemoteGATTServer { /** * Disconnect from a previously connected BLE device connected with - * `BluetoothRemoteGATTServer.connect` - this does not disconnect from something that has - * connected to the Espruino. - * **Note:** While `.disconnect` is standard Web Bluetooth, in the spec it - * returns undefined not a `Promise` for implementation reasons. In Espruino - * we return a `Promise` to make it easier to detect when Espruino is free - * to connect to something else. + * `BluetoothRemoteGATTServer.connect` - this does not disconnect from something + * that has connected to the Espruino. + * **Note:** While `.disconnect` is standard Web Bluetooth, in the spec it returns + * undefined not a `Promise` for implementation reasons. In Espruino we return a + * `Promise` to make it easier to detect when Espruino is free to connect to + * something else. * @returns {any} A `Promise` that is resolved (or rejected) when the disconnection is complete (non-standard) * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_disconnect */ - disconnect(): Promise; + disconnect(): Promise; /** - * Start negotiating bonding (secure communications) with the connected device, - * and return a Promise that is completed on success or failure. + * Start negotiating bonding (secure communications) with the connected device, and + * return a Promise that is completed on success or failure. * ``` * var gatt; * NRF.requestDevice({ filters: [{ name: 'Puck.js abcd' }] }).then(function(device) { @@ -4127,11 +4494,11 @@ declare class BluetoothRemoteGATTServer { * @returns {any} A `Promise` that is resolved (or rejected) when the bonding is complete * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_startBonding */ - startBonding(forceRePair: boolean): Promise; + startBonding(forceRePair: boolean): Promise; /** - * Return an object with information about the security - * state of the current connection: + * Return an object with information about the security state of the current + * connection: * ``` * { * connected // The connection is active (not disconnected). @@ -4140,8 +4507,8 @@ declare class BluetoothRemoteGATTServer { * bonded // The peer is bonded with us * } * ``` - * See `BluetoothRemoteGATTServer.startBonding` for information about - * negotiating a secure connection. + * See `BluetoothRemoteGATTServer.startBonding` for information about negotiating a + * secure connection. * **This is not part of the Web Bluetooth Specification.** It has been added * specifically for Puck.js. * @returns {any} An object @@ -4156,13 +4523,13 @@ declare class BluetoothRemoteGATTServer { * @returns {any} A `Promise` that is resolved (or rejected) when the primary service is found (the argument contains a `BluetoothRemoteGATTService`) * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_getPrimaryService */ - getPrimaryService(service: any): Promise; + getPrimaryService(service: any): Promise; /** * @returns {any} A `Promise` that is resolved (or rejected) when the primary services are found (the argument contains an array of `BluetoothRemoteGATTService`) * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_getPrimaryServices */ - getPrimaryServices(): Promise; + getPrimaryServices(): Promise; /** * Start/stop listening for RSSI values on the active GATT connection @@ -4179,11 +4546,12 @@ declare class BluetoothRemoteGATTServer { * @param {any} callback - The callback to call with the RSSI value, or undefined to stop * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTServer_setRSSIHandler */ - setRSSIHandler(callback: any): any; + setRSSIHandler(callback: any): void; } /** - * Web Bluetooth-style GATT service - get this using `BluetoothRemoteGATTServer.getPrimaryService(s)` + * Web Bluetooth-style GATT service - get this using + * `BluetoothRemoteGATTServer.getPrimaryService(s)` * https://webbluetoothcg.github.io/web-bluetooth/#bluetoothremotegattservice * @url http://www.espruino.com/Reference#BluetoothRemoteGATTService */ @@ -4203,23 +4571,25 @@ declare class BluetoothRemoteGATTService { * @returns {any} A `Promise` that is resolved (or rejected) when the characteristic is found (the argument contains a `BluetoothRemoteGATTCharacteristic`) * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTService_getCharacteristic */ - getCharacteristic(characteristic: any): Promise; + getCharacteristic(characteristic: any): Promise; /** * @returns {any} A `Promise` that is resolved (or rejected) when the characteristic is found (the argument contains an array of `BluetoothRemoteGATTCharacteristic`) * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTService_getCharacteristics */ - getCharacteristics(): Promise; + getCharacteristics(): Promise; } /** - * Web Bluetooth-style GATT characteristic - get this using `BluetoothRemoteGATTService.getCharacteristic(s)` + * Web Bluetooth-style GATT characteristic - get this using + * `BluetoothRemoteGATTService.getCharacteristic(s)` * https://webbluetoothcg.github.io/web-bluetooth/#bluetoothremotegattcharacteristic * @url http://www.espruino.com/Reference#BluetoothRemoteGATTCharacteristic */ declare class BluetoothRemoteGATTCharacteristic { /** - * Called when a characteristic's value changes, *after* `BluetoothRemoteGATTCharacteristic.startNotifications` has been called. + * Called when a characteristic's value changes, *after* + * `BluetoothRemoteGATTCharacteristic.startNotifications` has been called. * ``` * ... * return service.getCharacteristic("characteristic_uuid"); @@ -4230,8 +4600,10 @@ declare class BluetoothRemoteGATTCharacteristic { * return c.startNotifications(); * }).then(... * ``` - * The first argument is of the form `{target : BluetoothRemoteGATTCharacteristic}`, and `BluetoothRemoteGATTCharacteristic.value` - * will then contain the new value (as a DataView). + * The first argument is of the form `{target : + * BluetoothRemoteGATTCharacteristic}`, and + * `BluetoothRemoteGATTCharacteristic.value` will then contain the new value (as a + * DataView). * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTCharacteristic_characteristicvaluechanged @@ -4267,7 +4639,7 @@ declare class BluetoothRemoteGATTCharacteristic { * @returns {any} A `Promise` that is resolved (or rejected) when the characteristic is written * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTCharacteristic_writeValue */ - writeValue(data: any): Promise; + writeValue(data: any): Promise; /** * Read a characteristic's value, return a promise containing a `DataView` @@ -4291,11 +4663,12 @@ declare class BluetoothRemoteGATTCharacteristic { * @returns {any} A `Promise` that is resolved (or rejected) with a `DataView` when the characteristic is read * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTCharacteristic_readValue */ - readValue(): Promise; + readValue(): Promise; /** - * Starts notifications - whenever this characteristic's value changes, a `characteristicvaluechanged` event is fired - * and `characteristic.value` will then contain the new value as a `DataView`. + * Starts notifications - whenever this characteristic's value changes, a + * `characteristicvaluechanged` event is fired and `characteristic.value` will then + * contain the new value as a `DataView`. * ``` * var device; * NRF.connect(device_address).then(function(d) { @@ -4315,8 +4688,8 @@ declare class BluetoothRemoteGATTCharacteristic { * console.log("Something's broken."); * }); * ``` - * For example, to listen to the output of another Puck.js's Nordic - * Serial port service, you can use: + * For example, to listen to the output of another Puck.js's Nordic Serial port + * service, you can use: * ``` * var gatt; * NRF.connect("pu:ck:js:ad:dr:es random").then(function(g) { @@ -4336,18 +4709,20 @@ declare class BluetoothRemoteGATTCharacteristic { * @returns {any} A `Promise` that is resolved (or rejected) with data when notifications have been added * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTCharacteristic_startNotifications */ - startNotifications(): Promise; + startNotifications(): Promise; /** - * Stop notifications (that were requested with `BluetoothRemoteGATTCharacteristic.startNotifications`) + * Stop notifications (that were requested with + * `BluetoothRemoteGATTCharacteristic.startNotifications`) * @returns {any} A `Promise` that is resolved (or rejected) with data when notifications have been removed * @url http://www.espruino.com/Reference#l_BluetoothRemoteGATTCharacteristic_stopNotifications */ - stopNotifications(): Promise; + stopNotifications(): Promise; } /** - * Class containing utility functions for the [Bangle.js Smart Watch](http://www.espruino.com/Bangle.js) + * Class containing utility functions for the [Bangle.js Smart + * Watch](http://www.espruino.com/Bangle.js) * @url http://www.espruino.com/Reference#Bangle */ declare class Bangle { @@ -4364,7 +4739,7 @@ declare class Bangle { * * `xyz` * @url http://www.espruino.com/Reference#l_Bangle_accel */ - static on(event: "accel", callback: (xyz: any) => void): void; + static on(event: "accel", callback: (xyz: AccelData) => void): void; /** * Called whenever a step is detected by Bangle.js's pedometer. @@ -4376,14 +4751,14 @@ declare class Bangle { static on(event: "step", callback: (up: number) => void): void; /** - * See `Bangle.getHealthStatus()` for more information. This is used for health tracking to - * allow Bangle.js to record historical exercise data. + * See `Bangle.getHealthStatus()` for more information. This is used for health + * tracking to allow Bangle.js to record historical exercise data. * @param {string} event - The event to listen to. * @param {(info: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `info` An object containing the last 10 minutes health data * @url http://www.espruino.com/Reference#l_Bangle_health */ - static on(event: "health", callback: (info: any) => void): void; + static on(event: "health", callback: (info: HealthStatus) => void): void; /** * Has the watch been moved so that it is face-up, or not face up? @@ -4395,7 +4770,8 @@ declare class Bangle { static on(event: "faceUp", callback: (up: boolean) => void): void; /** - * This event happens when the watch has been twisted around it's axis - for instance as if it was rotated so someone could look at the time. + * This event happens when the watch has been twisted around it's axis - for + * instance as if it was rotated so someone could look at the time. * To tweak when this happens, see the `twist*` options in `Bangle.setOptions()` * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. @@ -4413,31 +4789,31 @@ declare class Bangle { static on(event: "charging", callback: (charging: boolean) => void): void; /** - * Magnetometer/Compass data available with `{x,y,z,dx,dy,dz,heading}` object as a parameter + * Magnetometer/Compass data available with `{x,y,z,dx,dy,dz,heading}` object as a + * parameter * * `x/y/z` raw x,y,z magnetometer readings * * `dx/dy/dz` readings based on calibration since magnetometer turned on - * * `heading` in degrees based on calibrated readings (will be NaN if magnetometer hasn't been rotated around 360 degrees) - * To get this event you must turn the compass on - * with `Bangle.setCompassPower(1)`. + * * `heading` in degrees based on calibrated readings (will be NaN if magnetometer + * hasn't been rotated around 360 degrees) + * To get this event you must turn the compass on with `Bangle.setCompassPower(1)`. * You can also retrieve the most recent reading with `Bangle.getCompass()`. * @param {string} event - The event to listen to. * @param {(xyz: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `xyz` * @url http://www.espruino.com/Reference#l_Bangle_mag */ - static on(event: "mag", callback: (xyz: any) => void): void; + static on(event: "mag", callback: (xyz: CompassData) => void): void; /** * Raw NMEA GPS / u-blox data messages received as a string - * To get this event you must turn the GPS on - * with `Bangle.setGPSPower(1)`. + * To get this event you must turn the GPS on with `Bangle.setGPSPower(1)`. * @param {string} event - The event to listen to. * @param {(nmea: any, dataLoss: boolean) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `nmea` A string containing the raw NMEA data from the GPS * * `dataLoss` This is set to true if some lines of GPS data have previously been lost (eg because system was too busy to queue up a GPS-raw event) * @url http://www.espruino.com/Reference#l_Bangle_GPS-raw */ - static on(event: "GPS-raw", callback: (nmea: any, dataLoss: boolean) => void): void; + static on(event: "GPS-raw", callback: (nmea: string, dataLoss: boolean) => void): void; /** * GPS data, as an object. Contains: @@ -4454,18 +4830,17 @@ declare class Bangle { * } * ``` * If a value such as `lat` is not known because there is no fix, it'll be `NaN`. - * `hdop` is a value from the GPS receiver that gives a rough idea of accuracy - * of lat/lon based on the geometry of the satellites in range. Multiply by 5 to - * get a value in meters. This is just a ballpark estimation and should - * not be considered remotely accurate. - * To get this event you must turn the GPS on - * with `Bangle.setGPSPower(1)`. + * `hdop` is a value from the GPS receiver that gives a rough idea of accuracy of + * lat/lon based on the geometry of the satellites in range. Multiply by 5 to get a + * value in meters. This is just a ballpark estimation and should not be considered + * remotely accurate. + * To get this event you must turn the GPS on with `Bangle.setGPSPower(1)`. * @param {string} event - The event to listen to. * @param {(fix: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `fix` An object with fix info (see below) * @url http://www.espruino.com/Reference#l_Bangle_GPS */ - static on(event: "GPS", callback: (fix: any) => void): void; + static on(event: "GPS", callback: (fix: GPSFix) => void): void; /** * Heat rate data, as an object. Contains: @@ -4475,14 +4850,14 @@ declare class Bangle { * "raw": Uint8Array, // raw samples from heart rate monitor * } * ``` - * To get this event you must turn the heart rate monitor on - * with `Bangle.setHRMPower(1)`. + * To get this event you must turn the heart rate monitor on with + * `Bangle.setHRMPower(1)`. * @param {string} event - The event to listen to. * @param {(hrm: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `hrm` An object with heart rate info (see below) * @url http://www.espruino.com/Reference#l_Bangle_HRM */ - static on(event: "HRM", callback: (hrm: any) => void): void; + static on(event: "HRM", callback: (hrm: { bpm: number, confidence: number, raw: Uint8Array }) => void): void; /** * Called when heart rate sensor data is available - see `Bangle.setHRMPower(1)`. @@ -4499,20 +4874,22 @@ declare class Bangle { * * `hrm` A object containing instant readings from the heart rate sensor * @url http://www.espruino.com/Reference#l_Bangle_HRM-raw */ - static on(event: "HRM-raw", callback: (hrm: any) => void): void; + static on(event: "HRM-raw", callback: (hrm: { raw: number, filt: number, bpm: number, confidence: number }) => void): void; /** - * When `Bangle.setBarometerPower(true)` is called, this event is fired containing barometer readings. + * When `Bangle.setBarometerPower(true)` is called, this event is fired containing + * barometer readings. * Same format as `Bangle.getPressure()` * @param {string} event - The event to listen to. * @param {(e: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `e` An object containing `{temperature,pressure,altitude}` * @url http://www.espruino.com/Reference#l_Bangle_pressure */ - static on(event: "pressure", callback: (e: any) => void): void; + static on(event: "pressure", callback: (e: PressureData) => void): void; /** - * Has the screen been turned on or off? Can be used to stop tasks that are no longer useful if nothing is displayed. Also see `Bangle.isLCDOn()` + * Has the screen been turned on or off? Can be used to stop tasks that are no + * longer useful if nothing is displayed. Also see `Bangle.isLCDOn()` * @param {string} event - The event to listen to. * @param {(on: boolean) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `on` `true` if screen is on @@ -4530,8 +4907,10 @@ declare class Bangle { static on(event: "lock", callback: (on: boolean) => void): void; /** - * If the watch is tapped, this event contains information on the way it was tapped. - * `dir` reports the side of the watch that was tapped (not the direction it was tapped in). + * If the watch is tapped, this event contains information on the way it was + * tapped. + * `dir` reports the side of the watch that was tapped (not the direction it was + * tapped in). * ``` * { * dir : "left/right/top/bottom/front/back", @@ -4545,7 +4924,7 @@ declare class Bangle { * * `data` `{dir, double, x, y, z}` * @url http://www.espruino.com/Reference#l_Bangle_tap */ - static on(event: "tap", callback: (data: any) => void): void; + static on(event: "tap", callback: (data: { dir: "left" | "right" | "top" | "bottom" | "front" | "back", double: boolean, x: TapAxis, y: TapAxis, z: TapAxis }) => void): void; /** * Emitted when a 'gesture' (fast movement) is detected @@ -4554,31 +4933,33 @@ declare class Bangle { * * `xyz` An Int8Array of XYZXYZXYZ data * @url http://www.espruino.com/Reference#l_Bangle_gesture */ - static on(event: "gesture", callback: (xyz: any) => void): void; + static on(event: "gesture", callback: (xyz: Int8Array) => void): void; /** - * Emitted when a 'gesture' (fast movement) is detected, and a Tensorflow model is in - * storage in the `".tfmodel"` file. - * If a `".tfnames"` file is specified as a comma-separated list of names, it will be used - * to decode `gesture` from a number into a string. + * Emitted when a 'gesture' (fast movement) is detected, and a Tensorflow model is + * in storage in the `".tfmodel"` file. + * If a `".tfnames"` file is specified as a comma-separated list of names, it will + * be used to decode `gesture` from a number into a string. * @param {string} event - The event to listen to. * @param {(gesture: any, weights: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `gesture` The name of the gesture (if '.tfnames' exists, or the index. 'undefined' if not matching * * `weights` An array of floating point values output by the model * @url http://www.espruino.com/Reference#l_Bangle_aiGesture */ - static on(event: "aiGesture", callback: (gesture: any, weights: any) => void): void; + static on(event: "aiGesture", callback: (gesture: string | undefined, weights: number[]) => void): void; /** - * Emitted when a swipe on the touchscreen is detected (a movement from left->right, right->left, down->up or up->down) - * Bangle.js 1 is only capable of detecting left/right swipes as it only contains a 2 zone touchscreen. + * Emitted when a swipe on the touchscreen is detected (a movement from + * left->right, right->left, down->up or up->down) + * Bangle.js 1 is only capable of detecting left/right swipes as it only contains a + * 2 zone touchscreen. * @param {string} event - The event to listen to. * @param {(directionLR: number, directionUD: number) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `directionLR` `-1` for left, `1` for right, `0` for up/down * * `directionUD` `-1` for up, `1` for down, `0` for left/right (Bangle.js 2 only) * @url http://www.espruino.com/Reference#l_Bangle_swipe */ - static on(event: "swipe", callback: (directionLR: number, directionUD: number) => void): void; + static on(event: "swipe", callback: SwipeCallback): void; /** * Emitted when the touchscreen is pressed @@ -4588,26 +4969,28 @@ declare class Bangle { * * `xy` Object of form `{x,y}` containing touch coordinates (if the device supports full touch). Clipped to 0..175 (LCD pixel coordinates) on firmware 2v13 and later. * @url http://www.espruino.com/Reference#l_Bangle_touch */ - static on(event: "touch", callback: (button: number, xy: any) => void): void; + static on(event: "touch", callback: TouchCallback): void; /** * Emitted when the touchscreen is dragged or released - * The touchscreen extends past the edge of the screen and while - * `x` and `y` coordinates are arranged such that they align with - * the LCD's pixels, if your finger goes towards the edge of the - * screen, `x` and `y` could end up larger than 175 (the screen's maximum pixel coordinates) - * or smaller than 0. Coordinates from the `touch` event are clipped. + * The touchscreen extends past the edge of the screen and while `x` and `y` + * coordinates are arranged such that they align with the LCD's pixels, if your + * finger goes towards the edge of the screen, `x` and `y` could end up larger than + * 175 (the screen's maximum pixel coordinates) or smaller than 0. Coordinates from + * the `touch` event are clipped. * @param {string} event - The event to listen to. * @param {(event: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `event` Object of form `{x,y,dx,dy,b}` containing touch coordinates, difference in touch coordinates, and an integer `b` containing number of touch points (currently 1 or 0) * @url http://www.espruino.com/Reference#l_Bangle_drag */ - static on(event: "drag", callback: (event: any) => void): void; + static on(event: "drag", callback: DragCallback): void; /** - * Emitted when the touchscreen is dragged for a large enough distance to count as a gesture. - * If Bangle.strokes is defined and populated with data from `Unistroke.new`, the `event` argument will also - * contain a `stroke` field containing the most closely matching stroke name. + * Emitted when the touchscreen is dragged for a large enough distance to count as + * a gesture. + * If Bangle.strokes is defined and populated with data from `Unistroke.new`, the + * `event` argument will also contain a `stroke` field containing the most closely + * matching stroke name. * For example: * ``` * Bangle.strokes = { @@ -4629,7 +5012,7 @@ declare class Bangle { * * `event` Object of form `{xy:Uint8Array([x1,y1,x2,y2...])}` containing touch coordinates * @url http://www.espruino.com/Reference#l_Bangle_stroke */ - static on(event: "stroke", callback: (event: any) => void): void; + static on(event: "stroke", callback: (event: { xy: Uint8Array, stroke?: string }) => void): void; /** * Emitted at midnight (at the point the `day` health info is reset to 0). @@ -4642,30 +5025,29 @@ declare class Bangle { /** * This function can be used to turn Bangle.js's LCD off or on. - * This function resets the Bangle's 'activity timer' (like - * pressing a button or the screen would) so after a time period - * of inactivity set by `Bangle.setLCDTimeout` the screen will - * turn off. - * If you want to keep the screen on permanently (until apps - * are changed) you can do: + * This function resets the Bangle's 'activity timer' (like pressing a button or + * the screen would) so after a time period of inactivity set by + * `Bangle.setLCDTimeout` the screen will turn off. + * If you want to keep the screen on permanently (until apps are changed) you can + * do: * ``` * Bangle.setLCDTimeout(0); // turn off the timeout * Bangle.setLCDPower(1); // keep screen on * ``` - * **When on full, the LCD draws roughly 40mA.** You can adjust - * When brightness using `Bange.setLCDBrightness`. + * **When on full, the LCD draws roughly 40mA.** You can adjust When brightness + * using `Bangle.setLCDBrightness`. * * @param {boolean} isOn - True if the LCD should be on, false if not * @url http://www.espruino.com/Reference#l_Bangle_setLCDPower */ - static setLCDPower(isOn: boolean): any; + static setLCDPower(isOn: boolean): void; /** * This function can be used to adjust the brightness of Bangle.js's display, and * hence prolong its battery life. - * Due to hardware design constraints, software PWM has to be used which - * means that the display may flicker slightly when Bluetooth is active - * and the display is not at full power. + * Due to hardware design constraints, software PWM has to be used which means that + * the display may flicker slightly when Bluetooth is active and the display is not + * at full power. * **Power consumption** * * 0 = 7mA * * 0.1 = 12mA @@ -4677,21 +5059,32 @@ declare class Bangle { * @param {number} brightness - The brightness of Bangle.js's display - from 0(off) to 1(on full) * @url http://www.espruino.com/Reference#l_Bangle_setLCDBrightness */ - static setLCDBrightness(brightness: number): any; + static setLCDBrightness(brightness: number): void; /** * This function can be used to change the way graphics is handled on Bangle.js. * Available options for `Bangle.setLCDMode` are: - * * `Bangle.setLCDMode()` or `Bangle.setLCDMode("direct")` (the default) - The drawable area is 240x240 16 bit. Unbuffered, so draw calls take effect immediately. Terminal and vertical scrolling work (horizontal scrolling doesn't). - * * `Bangle.setLCDMode("doublebuffered")` - The drawable area is 240x160 16 bit, terminal and scrolling will not work. `g.flip()` must be called for draw operations to take effect. - * * `Bangle.setLCDMode("120x120")` - The drawable area is 120x120 8 bit, `g.getPixel`, terminal, and full scrolling work. Uses an offscreen buffer stored on Bangle.js, `g.flip()` must be called for draw operations to take effect. - * * `Bangle.setLCDMode("80x80")` - The drawable area is 80x80 8 bit, `g.getPixel`, terminal, and full scrolling work. Uses an offscreen buffer stored on Bangle.js, `g.flip()` must be called for draw operations to take effect. - * You can also call `Bangle.setLCDMode()` to return to normal, unbuffered `"direct"` mode. + * * `Bangle.setLCDMode()` or `Bangle.setLCDMode("direct")` (the default) - The + * drawable area is 240x240 16 bit. Unbuffered, so draw calls take effect + * immediately. Terminal and vertical scrolling work (horizontal scrolling + * doesn't). + * * `Bangle.setLCDMode("doublebuffered")` - The drawable area is 240x160 16 bit, + * terminal and scrolling will not work. `g.flip()` must be called for draw + * operations to take effect. + * * `Bangle.setLCDMode("120x120")` - The drawable area is 120x120 8 bit, + * `g.getPixel`, terminal, and full scrolling work. Uses an offscreen buffer + * stored on Bangle.js, `g.flip()` must be called for draw operations to take + * effect. + * * `Bangle.setLCDMode("80x80")` - The drawable area is 80x80 8 bit, `g.getPixel`, + * terminal, and full scrolling work. Uses an offscreen buffer stored on + * Bangle.js, `g.flip()` must be called for draw operations to take effect. + * You can also call `Bangle.setLCDMode()` to return to normal, unbuffered + * `"direct"` mode. * * @param {any} mode - The LCD mode (See below) * @url http://www.espruino.com/Reference#l_Bangle_setLCDMode */ - static setLCDMode(mode: any): any; + static setLCDMode(mode?: LCDMode): void; /** * The current LCD mode. @@ -4699,7 +5092,7 @@ declare class Bangle { * @returns {any} The LCD mode as a String * @url http://www.espruino.com/Reference#l_Bangle_getLCDMode */ - static getLCDMode(): any; + static getLCDMode(): LCDMode; /** * This can be used to move the displayed memory area up or down temporarily. It's @@ -4709,68 +5102,97 @@ declare class Bangle { * @param {number} y - The amount of pixels to shift the LCD up or down * @url http://www.espruino.com/Reference#l_Bangle_setLCDOffset */ - static setLCDOffset(y: number): any; + static setLCDOffset(y: number): void; /** * This function can be used to turn Bangle.js's LCD power saving on or off. - * With power saving off, the display will remain in the state you set it with `Bangle.setLCDPower`. - * With power saving on, the display will turn on if a button is pressed, the watch is turned face up, or the screen is updated (see `Bangle.setOptions` for configuration). It'll turn off automatically after the given timeout. - * **Note:** This function also sets the Backlight and Lock timeout (the time at which the touchscreen/buttons start being ignored). To set both separately, use `Bangle.setOptions` + * With power saving off, the display will remain in the state you set it with + * `Bangle.setLCDPower`. + * With power saving on, the display will turn on if a button is pressed, the watch + * is turned face up, or the screen is updated (see `Bangle.setOptions` for + * configuration). It'll turn off automatically after the given timeout. + * **Note:** This function also sets the Backlight and Lock timeout (the time at + * which the touchscreen/buttons start being ignored). To set both separately, use + * `Bangle.setOptions` * * @param {number} isOn - The timeout of the display in seconds, or `0`/`undefined` to turn power saving off. Default is 10 seconds. * @url http://www.espruino.com/Reference#l_Bangle_setLCDTimeout */ - static setLCDTimeout(isOn: number): any; + static setLCDTimeout(isOn: number): void; /** - * Set how often the watch should poll for new acceleration/gyro data and kick the Watchdog timer. It isn't - * recommended that you make this interval much larger than 1000ms, but values up to 4000ms are allowed. - * Calling this will set `Bangle.setOptions({powerSave: false})` - disabling the dynamic adjustment of - * poll interval to save battery power when Bangle.js is stationary. + * Set how often the watch should poll for new acceleration/gyro data and kick the + * Watchdog timer. It isn't recommended that you make this interval much larger + * than 1000ms, but values up to 4000ms are allowed. + * Calling this will set `Bangle.setOptions({powerSave: false})` - disabling the + * dynamic adjustment of poll interval to save battery power when Bangle.js is + * stationary. * * @param {number} interval - Polling interval in milliseconds (Default is 80ms - 12.5Hz to match accelerometer) * @url http://www.espruino.com/Reference#l_Bangle_setPollInterval */ - static setPollInterval(interval: number): any; + static setPollInterval(interval: number): void; /** * Set internal options used for gestures, etc... * * `wakeOnBTN1` should the LCD turn on when BTN1 is pressed? default = `true` - * * `wakeOnBTN2` (Bangle.js 1) should the LCD turn on when BTN2 is pressed? default = `true` - * * `wakeOnBTN3` (Bangle.js 1) should the LCD turn on when BTN3 is pressed? default = `true` - * * `wakeOnFaceUp` should the LCD turn on when the watch is turned face up? default = `false` - * * `wakeOnTouch` should the LCD turn on when the touchscreen is pressed? default = `false` - * * `wakeOnTwist` should the LCD turn on when the watch is twisted? default = `true` - * * `twistThreshold` How much acceleration to register a twist of the watch strap? Can be negative for oppsite direction. default = `800` - * * `twistMaxY` Maximum acceleration in Y to trigger a twist (low Y means watch is facing the right way up). default = `-800` - * * `twistTimeout` How little time (in ms) must a twist take from low->high acceleration? default = `1000` - * * `gestureStartThresh` how big a difference before we consider a gesture started? default = `sqr(800)` - * * `gestureEndThresh` how small a difference before we consider a gesture ended? default = `sqr(2000)` - * * `gestureInactiveCount` how many samples do we keep after a gesture has ended? default = `4` - * * `gestureMinLength` how many samples must a gesture have before we notify about it? default = `10` - * * `powerSave` after a minute of not being moved, Bangle.js will change the accelerometer poll interval down to 800ms (10x accelerometer samples). - * On movement it'll be raised to the default 80ms. If `Bangle.setPollInterval` is used this is disabled, and for it to work the poll interval - * must be either 80ms or 800ms. default = `true`. Setting `powerSave:false` will disable this automatic power saving, but will **not** change - * the poll interval from its current value. If you desire a specific interval (eg the default 80ms) you must set it manually with `Bangle.setPollInterval(80)` - * after setting `powerSave:false`. + * * `wakeOnBTN2` (Bangle.js 1) should the LCD turn on when BTN2 is pressed? + * default = `true` + * * `wakeOnBTN3` (Bangle.js 1) should the LCD turn on when BTN3 is pressed? + * default = `true` + * * `wakeOnFaceUp` should the LCD turn on when the watch is turned face up? + * default = `false` + * * `wakeOnTouch` should the LCD turn on when the touchscreen is pressed? default + * = `false` + * * `wakeOnTwist` should the LCD turn on when the watch is twisted? default = + * `true` + * * `twistThreshold` How much acceleration to register a twist of the watch strap? + * Can be negative for opposite direction. default = `800` + * * `twistMaxY` Maximum acceleration in Y to trigger a twist (low Y means watch is + * facing the right way up). default = `-800` + * * `twistTimeout` How little time (in ms) must a twist take from low->high + * acceleration? default = `1000` + * * `gestureStartThresh` how big a difference before we consider a gesture + * started? default = `sqr(800)` + * * `gestureEndThresh` how small a difference before we consider a gesture ended? + * default = `sqr(2000)` + * * `gestureInactiveCount` how many samples do we keep after a gesture has ended? + * default = `4` + * * `gestureMinLength` how many samples must a gesture have before we notify about + * it? default = `10` + * * `powerSave` after a minute of not being moved, Bangle.js will change the + * accelerometer poll interval down to 800ms (10x accelerometer samples). On + * movement it'll be raised to the default 80ms. If `Bangle.setPollInterval` is + * used this is disabled, and for it to work the poll interval must be either + * 80ms or 800ms. default = `true`. Setting `powerSave:false` will disable this + * automatic power saving, but will **not** change the poll interval from its + * current value. If you desire a specific interval (e.g. the default 80ms) you + * must set it manually with `Bangle.setPollInterval(80)` after setting + * `powerSave:false`. * * `lockTimeout` how many milliseconds before the screen locks * * `lcdPowerTimeout` how many milliseconds before the screen turns off - * * `backlightTimeout` how many milliseconds before the screen's backlight turns off - * * `hrmPollInterval` set the requested poll interval (in milliseconds) for the heart rate monitor. On Bangle.js 2 only 10,20,40,80,160,200 ms are supported, and polling rate may not be exact. The algorithm's filtering is tuned for 20-40ms poll intervals, so higher/lower intervals may effect the reliability of the BPM reading. - * * `seaLevelPressure` (Bangle.js 2) Normally 1013.25 millibars - this is used for calculating altitude with the pressure sensor + * * `backlightTimeout` how many milliseconds before the screen's backlight turns + * off + * * `hrmPollInterval` set the requested poll interval (in milliseconds) for the + * heart rate monitor. On Bangle.js 2 only 10,20,40,80,160,200 ms are supported, + * and polling rate may not be exact. The algorithm's filtering is tuned for + * 20-40ms poll intervals, so higher/lower intervals may effect the reliability + * of the BPM reading. + * * `seaLevelPressure` (Bangle.js 2) Normally 1013.25 millibars - this is used for + * calculating altitude with the pressure sensor * Where accelerations are used they are in internal units, where `8192 = 1g` * * @param {any} options * @url http://www.espruino.com/Reference#l_Bangle_setOptions */ - static setOptions(options: any): any; + static setOptions(options: { [key in keyof BangleOptions]?: BangleOptions[key] }): void; /** * Return the current state of options as set by `Bangle.setOptions` * @returns {any} The current state of all options * @url http://www.espruino.com/Reference#l_Bangle_getOptions */ - static getOptions(): any; + static getOptions(): BangleOptions; /** * Also see the `Bangle.lcdPower` event @@ -4780,13 +5202,13 @@ declare class Bangle { static isLCDOn(): boolean; /** - * This function can be used to lock or unlock Bangle.js - * (eg whether buttons and touchscreen work or not) + * This function can be used to lock or unlock Bangle.js (e.g. whether buttons and + * touchscreen work or not) * * @param {boolean} isLocked - `true` if the Bangle is locked (no user input allowed) * @url http://www.espruino.com/Reference#l_Bangle_setLocked */ - static setLocked(isLocked: boolean): any; + static setLocked(isLocked: boolean): void; /** * Also see the `Bangle.lock` event @@ -4808,7 +5230,7 @@ declare class Bangle { * @param {any} data * @url http://www.espruino.com/Reference#l_Bangle_lcdWr */ - static lcdWr(cmd: number, data: any): any; + static lcdWr(cmd: number, data: any): void; /** * Set the power to the Heart rate monitor @@ -4824,7 +5246,7 @@ declare class Bangle { * @returns {boolean} Is HRM on? * @url http://www.espruino.com/Reference#l_Bangle_setHRMPower */ - static setHRMPower(isOn: boolean, appID: any): boolean; + static setHRMPower(isOn: boolean, appID: string): boolean; /** * Is the Heart rate monitor powered? @@ -4848,7 +5270,7 @@ declare class Bangle { * @returns {boolean} Is the GPS on? * @url http://www.espruino.com/Reference#l_Bangle_setGPSPower */ - static setGPSPower(isOn: boolean, appID: any): boolean; + static setGPSPower(isOn: boolean, appID: string): boolean; /** * Is the GPS powered? @@ -4864,7 +5286,7 @@ declare class Bangle { * @returns {any} A GPS fix object with `{lat,lon,...}` * @url http://www.espruino.com/Reference#l_Bangle_getGPSFix */ - static getGPSFix(): any; + static getGPSFix(): GPSFix; /** * Set the power to the Compass @@ -4880,7 +5302,7 @@ declare class Bangle { * @returns {boolean} Is the Compass on? * @url http://www.espruino.com/Reference#l_Bangle_setCompassPower */ - static setCompassPower(isOn: boolean, appID: any): boolean; + static setCompassPower(isOn: boolean, appID: string): boolean; /** * Is the compass powered? @@ -4896,11 +5318,11 @@ declare class Bangle { * * @url http://www.espruino.com/Reference#l_Bangle_resetCompass */ - static resetCompass(): any; + static resetCompass(): void; /** - * Set the power to the barometer IC. Once enbled, `Bangle.pressure` events - * are fired each time a new barometer reading is available. + * Set the power to the barometer IC. Once enabled, `Bangle.pressure` events are + * fired each time a new barometer reading is available. * When on, the barometer draws roughly 50uA * * @param {boolean} isOn - True if the barometer IC should be on, false if not @@ -4908,7 +5330,7 @@ declare class Bangle { * @returns {boolean} Is the Barometer on? * @url http://www.espruino.com/Reference#l_Bangle_setBarometerPower */ - static setBarometerPower(isOn: boolean, appID: any): boolean; + static setBarometerPower(isOn: boolean, appID: string): boolean; /** * Is the Barometer powered? @@ -4931,41 +5353,46 @@ declare class Bangle { * @param {number} count - The value with which to reload the step counter * @url http://www.espruino.com/Reference#l_Bangle_setStepCount */ - static setStepCount(count: number): any; + static setStepCount(count: number): void; /** - * Get the most recent Magnetometer/Compass reading. Data is in the same format as the `Bangle.on('mag',` event. + * Get the most recent Magnetometer/Compass reading. Data is in the same format as + * the `Bangle.on('mag',` event. * Returns an `{x,y,z,dx,dy,dz,heading}` object * * `x/y/z` raw x,y,z magnetometer readings * * `dx/dy/dz` readings based on calibration since magnetometer turned on - * * `heading` in degrees based on calibrated readings (will be NaN if magnetometer hasn't been rotated around 360 degrees) - * To get this event you must turn the compass on - * with `Bangle.setCompassPower(1)`. + * * `heading` in degrees based on calibrated readings (will be NaN if magnetometer + * hasn't been rotated around 360 degrees) + * To get this event you must turn the compass on with `Bangle.setCompassPower(1)`. * @returns {any} An object containing magnetometer readings (as below) * @url http://www.espruino.com/Reference#l_Bangle_getCompass */ - static getCompass(): any; + static getCompass(): CompassData; /** - * Get the most recent accelerometer reading. Data is in the same format as the `Bangle.on('accel',` event. + * Get the most recent accelerometer reading. Data is in the same format as the + * `Bangle.on('accel',` event. * * `x` is X axis (left-right) in `g` * * `y` is Y axis (up-down) in `g` * * `z` is Z axis (in-out) in `g` - * * `diff` is difference between this and the last reading in `g` (calculated by comparing vectors, not magnitudes) + * * `diff` is difference between this and the last reading in `g` (calculated by + * comparing vectors, not magnitudes) * * `td` is the elapsed * * `mag` is the magnitude of the acceleration in `g` * @returns {any} An object containing accelerometer readings (as below) * @url http://www.espruino.com/Reference#l_Bangle_getAccel */ - static getAccel(): any; + static getAccel(): AccelData & { td: number }; /** * `range` is one of: - * * `undefined` or `'current'` - health data so far in the last 10 minutes is returned, + * * `undefined` or `'current'` - health data so far in the last 10 minutes is + * returned, * * `'last'` - health data during the last 10 minutes * * `'day'` - the health data so far for the day * `getHealthStatus` returns an object containing: - * * `movement` is the 32 bit sum of all `acc.diff` readings since power on (and rolls over). It is the difference in accelerometer values as `g*8192` + * * `movement` is the 32 bit sum of all `acc.diff` readings since power on (and + * rolls over). It is the difference in accelerometer values as `g*8192` * * `steps` is the number of steps during this period * * `bpm` the best BPM reading from HRM sensor during this period * * `bpmConfidence` best BPM confidence (0-100%) during this period @@ -4974,12 +5401,12 @@ declare class Bangle { * @returns {any} Returns an object containing various health info * @url http://www.espruino.com/Reference#l_Bangle_getHealthStatus */ - static getHealthStatus(range: any): any; + static getHealthStatus(range?: "current" | "last" | "day"): HealthStatus; /** * Feature flag - If true, this Bangle.js firmware reads `setting.json` and - * modifies beep & buzz behaviour accordingly (the bootloader - * doesn't need to do it). + * modifies beep & buzz behaviour accordingly (the bootloader doesn't need to do + * it). * @returns {boolean} * @url http://www.espruino.com/Reference#l_Bangle_F_BEEPSET */ @@ -4999,18 +5426,20 @@ declare class Bangle { * @param {number} data * @url http://www.espruino.com/Reference#l_Bangle_accelWr */ - static accelWr(reg: number, data: number): any; + static accelWr(reg: number, data: number): void; /** * Reads a register from the accelerometer - * **Note:** On Espruino 2v06 and before this function only returns a number (`cnt` is ignored). + * **Note:** On Espruino 2v06 and before this function only returns a number (`cnt` + * is ignored). * * @param {number} reg * @param {number} cnt - If specified, returns an array of the given length (max 128). If not (or 0) it returns a number * @returns {any} * @url http://www.espruino.com/Reference#l_Bangle_accelRd */ - static accelRd(reg: number, cnt: number): any; + static accelRd(reg: number, cnt?: 0): number; + static accelRd(reg: number, cnt: number): number[]; /** * Writes a register on the barometer IC @@ -5019,7 +5448,7 @@ declare class Bangle { * @param {number} data * @url http://www.espruino.com/Reference#l_Bangle_barometerWr */ - static barometerWr(reg: number, data: number): any; + static barometerWr(reg: number, data: number): void; /** * Reads a register from the barometer IC @@ -5029,7 +5458,8 @@ declare class Bangle { * @returns {any} * @url http://www.espruino.com/Reference#l_Bangle_barometerRd */ - static barometerRd(reg: number, cnt: number): any; + static barometerRd(reg: number, cnt?: 0): number; + static barometerRd(reg: number, cnt: number): number[]; /** * Writes a register on the Magnetometer/Compass @@ -5038,7 +5468,7 @@ declare class Bangle { * @param {number} data * @url http://www.espruino.com/Reference#l_Bangle_compassWr */ - static compassWr(reg: number, data: number): any; + static compassWr(reg: number, data: number): void; /** * Read a register on the Magnetometer/Compass @@ -5048,7 +5478,8 @@ declare class Bangle { * @returns {any} * @url http://www.espruino.com/Reference#l_Bangle_compassRd */ - static compassRd(reg: number, cnt: number): any; + static compassRd(reg: number, cnt?: 0): number; + static compassRd(reg: number, cnt: number): number[]; /** * Writes a register on the Heart rate monitor @@ -5057,7 +5488,7 @@ declare class Bangle { * @param {number} data * @url http://www.espruino.com/Reference#l_Bangle_hrmWr */ - static hrmWr(reg: number, data: number): any; + static hrmWr(reg: number, data: number): void; /** * Read a register on the Heart rate monitor @@ -5067,7 +5498,8 @@ declare class Bangle { * @returns {any} * @url http://www.espruino.com/Reference#l_Bangle_hrmRd */ - static hrmRd(reg: number, cnt: number): any; + static hrmRd(reg: number, cnt?: 0): number; + static hrmRd(reg: number, cnt: number): number[]; /** * Changes a pin state on the IO expander @@ -5076,14 +5508,14 @@ declare class Bangle { * @param {number} isOn * @url http://www.espruino.com/Reference#l_Bangle_ioWr */ - static ioWr(mask: number, isOn: number): any; + static ioWr(mask: number, isOn: number): void; /** - * Read temperature, pressure and altitude data. A promise is returned - * which will be resolved with `{temperature, pressure, altitude}`. - * If the Barometer has been turned on with `Bangle.setBarometerPower` then this will - * return almost immediately with the reading. If the Barometer is off, conversions take - * between 500-750ms. + * Read temperature, pressure and altitude data. A promise is returned which will + * be resolved with `{temperature, pressure, altitude}`. + * If the Barometer has been turned on with `Bangle.setBarometerPower` then this + * will return almost immediately with the reading. If the Barometer is off, + * conversions take between 500-750ms. * Altitude assumes a sea-level pressure of 1013.25 hPa * ``` * Bangle.getPressure().then(d=>{ @@ -5094,30 +5526,31 @@ declare class Bangle { * @returns {any} A promise that will be resolved with `{temperature, pressure, altitude}` * @url http://www.espruino.com/Reference#l_Bangle_getPressure */ - static getPressure(): any; + static getPressure(): PressureData; /** - * Perform a Spherical [Web Mercator projection](https://en.wikipedia.org/wiki/Web_Mercator_projection) - * of latitude and longitude into `x` and `y` coordinates, which are roughly - * equivalent to meters from `{lat:0,lon:0}`. - * This is the formula used for most online mapping and is a good way - * to compare GPS coordinates to work out the distance between them. + * Perform a Spherical [Web Mercator + * projection](https://en.wikipedia.org/wiki/Web_Mercator_projection) of latitude + * and longitude into `x` and `y` coordinates, which are roughly equivalent to + * meters from `{lat:0,lon:0}`. + * This is the formula used for most online mapping and is a good way to compare + * GPS coordinates to work out the distance between them. * * @param {any} latlong - `{lat:..., lon:...}` * @returns {any} {x:..., y:...} * @url http://www.espruino.com/Reference#l_Bangle_project */ - static project(latlong: any): any; + static project(latlong: { lat: number, lon: number }): { x: number, y: number }; /** * Use the piezo speaker to Beep for a certain time period and frequency * - * @param {number} time - Time in ms (default 200) - * @param {number} freq - Frequency in hz (default 4000) + * @param {number} [time] - [optional] Time in ms (default 200) + * @param {number} [freq] - [optional] Frequency in hz (default 4000) * @returns {any} A promise, completed when beep is finished * @url http://www.espruino.com/Reference#l_Bangle_beep */ - static beep(time: number, freq: number): Promise; + static beep(time?: number, freq?: number): Promise; /** * Use the vibration motor to buzz for a certain time period @@ -5127,20 +5560,20 @@ declare class Bangle { * @returns {any} A promise, completed when vibration is finished * @url http://www.espruino.com/Reference#l_Bangle_buzz */ - static buzz(time?: number, strength?: number): Promise; + static buzz(time?: number, strength?: number): Promise; /** * Turn Bangle.js off. It can only be woken by pressing BTN1. * @url http://www.espruino.com/Reference#l_Bangle_off */ - static off(): any; + static off(): void; /** - * Turn Bangle.js (mostly) off, but keep the CPU in sleep - * mode until BTN1 is pressed to preserve the RTC (current time). + * Turn Bangle.js (mostly) off, but keep the CPU in sleep mode until BTN1 is + * pressed to preserve the RTC (current time). * @url http://www.espruino.com/Reference#l_Bangle_softOff */ - static softOff(): any; + static softOff(): void; /** * * On platforms with an LCD of >=8bpp this is 222 x 104 x 2 bits @@ -5148,59 +5581,67 @@ declare class Bangle { * @returns {any} An image to be used with `g.drawImage` (as a String) * @url http://www.espruino.com/Reference#l_Bangle_getLogo */ - static getLogo(): any; + static getLogo(): string; /** - * Load all widgets from flash Storage. Call this once at the beginning - * of your application if you want any on-screen widgets to be loaded. - * They will be loaded into a global `WIDGETS` array, and - * can be rendered with `Bangle.drawWidgets`. + * Load all widgets from flash Storage. Call this once at the beginning of your + * application if you want any on-screen widgets to be loaded. + * They will be loaded into a global `WIDGETS` array, and can be rendered with + * `Bangle.drawWidgets`. * @url http://www.espruino.com/Reference#l_Bangle_loadWidgets */ - static loadWidgets(): any; + static loadWidgets(): void; /** * Draw any onscreen widgets that were loaded with `Bangle.loadWidgets()`. - * Widgets should redraw themselves when something changes - you'll only - * need to call drawWidgets if you decide to clear the entire screen - * with `g.clear()`. + * Widgets should redraw themselves when something changes - you'll only need to + * call drawWidgets if you decide to clear the entire screen with `g.clear()`. * @url http://www.espruino.com/Reference#l_Bangle_drawWidgets */ - static drawWidgets(): any; + static drawWidgets(): void; /** * @url http://www.espruino.com/Reference#l_Bangle_drawWidgets */ - static drawWidgets(): any; + static drawWidgets(): void; /** - * Load the Bangle.js app launcher, which will allow the user - * to select an application to launch. + * Load the Bangle.js app launcher, which will allow the user to select an + * application to launch. * @url http://www.espruino.com/Reference#l_Bangle_showLauncher */ - static showLauncher(): any; + static showLauncher(): void; /** - * This puts Bangle.js into the specified UI input mode, and calls the callback provided when there is user input. + * This puts Bangle.js into the specified UI input mode, and calls the callback + * provided when there is user input. * Currently supported interface types are: - * * 'updown' - UI input with upwards motion `cb(-1)`, downwards motion `cb(1)`, and select `cb()` + * * 'updown' - UI input with upwards motion `cb(-1)`, downwards motion `cb(1)`, + * and select `cb()` * * Bangle.js 1 uses BTN1/3 for up/down and BTN2 for select * * Bangle.js 2 uses touchscreen swipe up/down and tap - * * 'leftright' - UI input with left motion `cb(-1)`, right motion `cb(1)`, and select `cb()` + * * 'leftright' - UI input with left motion `cb(-1)`, right motion `cb(1)`, and + * select `cb()` * * Bangle.js 1 uses BTN1/3 for left/right and BTN2 for select * * Bangle.js 2 uses touchscreen swipe left/right and tap/BTN1 for select - * * 'clock' - called for clocks. Sets `Bangle.CLOCK=1` and allows a button to start the launcher + * * 'clock' - called for clocks. Sets `Bangle.CLOCK=1` and allows a button to + * start the launcher * * Bangle.js 1 BTN2 starts the launcher * * Bangle.js 2 BTN1 starts the launcher - * * 'clockupdown' - called for clocks. Sets `Bangle.CLOCK=1`, allows a button to start the launcher, but also provides up/down functionality + * * 'clockupdown' - called for clocks. Sets `Bangle.CLOCK=1`, allows a button to + * start the launcher, but also provides up/down functionality * * Bangle.js 1 BTN2 starts the launcher, BTN1/BTN3 call `cb(-1)` and `cb(1)` - * * Bangle.js 2 BTN1 starts the launcher, touchscreen tap in top/bottom right hand side calls `cb(-1)` and `cb(1)` - * * `{mode:"custom", ...}` allows you to specify custom handlers for different interations. See below. + * * Bangle.js 2 BTN1 starts the launcher, touchscreen tap in top/bottom right + * hand side calls `cb(-1)` and `cb(1)` + * * `{mode:"custom", ...}` allows you to specify custom handlers for different + * interactions. See below. * * `undefined` removes all user interaction code - * While you could use setWatch/etc manually, the benefit here is that you don't end up with multiple `setWatch` instances, and - * the actual input method (touch, or buttons) is implemented dependent on the watch (Bangle.js 1 or 2) - * **Note:** You can override this function in boot code to change the interaction mode with the watch. For instance - * you could make all clocks start the launcher with a swipe by using: + * While you could use setWatch/etc manually, the benefit here is that you don't + * end up with multiple `setWatch` instances, and the actual input method (touch, + * or buttons) is implemented dependent on the watch (Bangle.js 1 or 2) + * **Note:** You can override this function in boot code to change the interaction + * mode with the watch. For instance you could make all clocks start the launcher + * with a swipe by using: * ``` * (function() { * var sui = Bangle.setUI; @@ -5213,7 +5654,8 @@ declare class Bangle { * }; * })(); * ``` - * The first argument can also be an object, in which case more options can be specified: + * The first argument can also be an object, in which case more options can be + * specified: * ``` * Bangle.setUI({ * mode : "custom", @@ -5230,50 +5672,50 @@ declare class Bangle { * @param {any} callback - A function with one argument which is the direction * @url http://www.espruino.com/Reference#l_Bangle_setUI */ - static setUI(type: any, callback: any): any; + static setUI(type?: "updown" | "leftright" | "clock" | "clockupdown" | { mode: "custom"; back?: () => void; touch?: TouchCallback; swipe?: SwipeCallback; drag?: DragCallback; btn?: (n: number) => void, clock?: boolean }, callback?: (direction?: -1 | 1) => void): void; /** * @url http://www.espruino.com/Reference#l_Bangle_setUI */ - static setUI(): any; + static setUI(): void; /** - * Erase all storage and reload it with the default - * contents. - * This is only available on Bangle.js 2.0. On Bangle.js 1.0 - * you need to use `Install Default Apps` under the `More...` tab - * of http://banglejs.com/apps + * Erase all storage and reload it with the default contents. + * This is only available on Bangle.js 2.0. On Bangle.js 1.0 you need to use + * `Install Default Apps` under the `More...` tab of http://banglejs.com/apps * @url http://www.espruino.com/Reference#l_Bangle_factoryReset */ - static factoryReset(): any; + static factoryReset(): void; /** - * Returns the rectangle on the screen that is currently - * reserved for the app. + * Returns the rectangle on the screen that is currently reserved for the app. * @returns {any} An object of the form `{x,y,w,h,x2,y2}` * @url http://www.espruino.com/Reference#l_Bangle_appRect */ - static appRect: any; - + static appRect: { x: number, y: number, w: number, h: number, x2: number, y2: number }; + static CLOCK: boolean; + static strokes: undefined | { [key: string]: Unistroke }; } interface DateConstructor { /** - * Get the number of milliseconds elapsed since 1970 (or on embedded platforms, since startup) + * Get the number of milliseconds elapsed since 1970 (or on embedded platforms, + * since startup) * @returns {number} * @url http://www.espruino.com/Reference#l_Date_now */ now(): number; /** - * Parse a date string and return milliseconds since 1970. Data can be either '2011-10-20T14:48:00', '2011-10-20' or 'Mon, 25 Dec 1995 13:30:00 +0430' + * Parse a date string and return milliseconds since 1970. Data can be either + * '2011-10-20T14:48:00', '2011-10-20' or 'Mon, 25 Dec 1995 13:30:00 +0430' * * @param {any} str - A String * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_parse */ - parse(str: any): number; + parse(str: string): number; /** * Creates a date object @@ -5283,7 +5725,9 @@ interface DateConstructor { * @returns {any} A Date object * @url http://www.espruino.com/Reference#l_Date_Date */ - new(...args: any[]): Date; + new(): Date; + new(value: number | string): Date; + new(year: number, month: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): Date; } interface Date { @@ -5299,7 +5743,7 @@ interface Date { * @returns {number} true if daylight savings time is in effect * @url http://www.espruino.com/Reference#l_Date_getIsDST */ - getIsDST(): number; + getIsDST(): boolean /** * Return the number of milliseconds since 1970 @@ -5390,7 +5834,7 @@ interface Date { * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_setHours */ - setHours(hoursValue: number, minutesValue: any, secondsValue: any, millisecondsValue: any): number; + setHours(hoursValue: number, minutesValue?: number, secondsValue?: number, millisecondsValue?: number): number; /** * 0..59 @@ -5401,7 +5845,7 @@ interface Date { * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_setMinutes */ - setMinutes(minutesValue: number, secondsValue: any, millisecondsValue: any): number; + setMinutes(minutesValue: number, secondsValue?: number, millisecondsValue?: number): number; /** * 0..59 @@ -5411,7 +5855,7 @@ interface Date { * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_setSeconds */ - setSeconds(secondsValue: number, millisecondsValue: any): number; + setSeconds(secondsValue: number, millisecondsValue?: number): number; /** * @@ -5438,7 +5882,7 @@ interface Date { * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_setMonth */ - setMonth(yearValue: number, dayValue: any): number; + setMonth(yearValue: number, dayValue?: number): number; /** * @@ -5448,15 +5892,16 @@ interface Date { * @returns {number} The number of milliseconds since 1970 * @url http://www.espruino.com/Reference#l_Date_setFullYear */ - setFullYear(yearValue: number, monthValue: any, dayValue: any): number; + setFullYear(yearValue: number, monthValue?: number, dayValue?: number): number; /** * Converts to a String, eg: `Fri Jun 20 2014 14:52:20 GMT+0000` - * **Note:** This uses whatever timezone was set with `E.setTimeZone()` or `E.setDST()` + * **Note:** This uses whatever timezone was set with `E.setTimeZone()` or + * `E.setDST()` * @returns {any} A String * @url http://www.espruino.com/Reference#l_Date_toString */ - toString(): any; + toString(): string; /** * Converts to a String, eg: `Fri, 20 Jun 2014 14:52:20 GMT` @@ -5464,7 +5909,7 @@ interface Date { * @returns {any} A String * @url http://www.espruino.com/Reference#l_Date_toUTCString */ - toUTCString(): any; + toUTCString(): string; /** * Converts to a ISO 8601 String, eg: `2014-06-20T14:52:20.123Z` @@ -5472,36 +5917,38 @@ interface Date { * @returns {any} A String * @url http://www.espruino.com/Reference#l_Date_toISOString */ - toISOString(): any; + toISOString(): string; /** * Calls `Date.toISOString` to output this date to JSON * @returns {any} A String * @url http://www.espruino.com/Reference#l_Date_toJSON */ - toJSON(): any; + toJSON(): string; /** - * Converts to a ISO 8601 String (with timezone information), eg: `2014-06-20T14:52:20.123-0500` + * Converts to a ISO 8601 String (with timezone information), eg: + * `2014-06-20T14:52:20.123-0500` * @returns {any} A String * @url http://www.espruino.com/Reference#l_Date_toLocalISOString */ - toLocalISOString(): any; + toLocalISOString(): string; } /** * The built-in class for handling Dates. - * **Note:** By default the time zone is GMT+0, however you can change the - * timezone using the `E.setTimeZone(...)` function. + * **Note:** By default the time zone is GMT+0, however you can change the timezone + * using the `E.setTimeZone(...)` function. * For example `E.setTimeZone(1)` will be GMT+0100 - * *However* if you have daylight savings time set with `E.setDST(...)` then the timezone set - * by `E.setTimeZone(...)` will be _ignored_. + * *However* if you have daylight savings time set with `E.setDST(...)` then the + * timezone set by `E.setTimeZone(...)` will be _ignored_. * @url http://www.espruino.com/Reference#Date */ declare const Date: DateConstructor /** - * This class provides a software-defined OneWire master. It is designed to be similar to Arduino's OneWire library. + * This class provides a software-defined OneWire master. It is designed to be + * similar to Arduino's OneWire library. * @url http://www.espruino.com/Reference#OneWire */ declare class OneWire { @@ -5528,13 +5975,13 @@ declare class OneWire { * @param {any} rom - The device to select (get this using `OneWire.search()`) * @url http://www.espruino.com/Reference#l_OneWire_select */ - select(rom: any): any; + select(rom: any): void; /** * Skip a ROM * @url http://www.espruino.com/Reference#l_OneWire_skip */ - skip(): any; + skip(): void; /** * Write one or more bytes @@ -5543,7 +5990,7 @@ declare class OneWire { * @param {boolean} power - Whether to leave power on after write (default is false) * @url http://www.espruino.com/Reference#l_OneWire_write */ - write(data: any, power: boolean): any; + write(data: any, power: boolean): void; /** * Read a byte @@ -5632,7 +6079,7 @@ interface ArrayBufferConstructor { * @returns {any} An ArrayBuffer object * @url http://www.espruino.com/Reference#l_ArrayBuffer_ArrayBuffer */ - new(byteLength: number): any; + new(byteLength: number): ArrayBuffer; } interface ArrayBuffer { @@ -5646,8 +6093,8 @@ interface ArrayBuffer { /** * This is the built-in JavaScript class for array buffers. - * If you want to access arrays of differing types of data - * you may also find `DataView` useful. + * If you want to access arrays of differing types of data you may also find + * `DataView` useful. * @url http://www.espruino.com/Reference#ArrayBuffer */ declare const ArrayBuffer: ArrayBufferConstructor @@ -5664,11 +6111,11 @@ declare const ArrayBuffer: ArrayBufferConstructor * * [Int32Array](/Reference#Int32Array) * * [Float32Array](/Reference#Float32Array) * * [Float64Array](/Reference#Float64Array) - * If you want to access arrays of differing types of data - * you may also find `DataView` useful. + * If you want to access arrays of differing types of data you may also find + * `DataView` useful. * @url http://www.espruino.com/Reference#ArrayBufferView */ -declare class ArrayBufferView { +declare class ArrayBufferView { /** @@ -5676,21 +6123,22 @@ declare class ArrayBufferView { * @returns {any} An ArrayBuffer object * @url http://www.espruino.com/Reference#l_ArrayBufferView_buffer */ - buffer: ArrayBuffer; + readonly buffer: T; /** * The length, in bytes, of the `ArrayBufferView` * @returns {number} The Length * @url http://www.espruino.com/Reference#l_ArrayBufferView_byteLength */ - byteLength: number; + readonly byteLength: number; /** - * The offset, in bytes, to the first byte of the view within the backing `ArrayBuffer` + * The offset, in bytes, to the first byte of the view within the backing + * `ArrayBuffer` * @returns {number} The byte Offset * @url http://www.espruino.com/Reference#l_ArrayBufferView_byteOffset */ - byteOffset: number; + readonly byteOffset: number; /** * Copy the contents of `array` into this one, mapping `this[x+offset]=array[x];` @@ -5699,28 +6147,31 @@ declare class ArrayBufferView { * @param {number} offset - The offset in this array at which to write the values (optional) * @url http://www.espruino.com/Reference#l_ArrayBufferView_set */ - set(arr: any, offset: number): any; + set(arr: ArrayLike, offset: number): void /** - * Return an array which is made from the following: ```A.map(function) = [function(A[0]), function(A[1]), ...]``` - * **Note:** This returns an `ArrayBuffer` of the same type it was called on. To get an `Array`, use `Array.map`, eg. `[].map.call(myArray, x=>x+1)` + * Return an array which is made from the following: ```A.map(function) = + * [function(A[0]), function(A[1]), ...]``` + * **Note:** This returns an `ArrayBuffer` of the same type it was called on. To + * get an `Array`, use `Array.map`, e.g. `[].map.call(myArray, x=>x+1)` * * @param {any} function - Function used to map one item to another * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @returns {any} An array containing the results * @url http://www.espruino.com/Reference#l_ArrayBufferView_map */ - map(func: any, thisArg: any): ArrayBufferView; + map(callbackfn: (value: number, index: number, array: T) => number, thisArg?: any): T; /** - * Returns a smaller part of this array which references the same data (it doesn't copy it). + * Returns a smaller part of this array which references the same data (it doesn't + * copy it). * * @param {number} begin - Element to begin at, inclusive. If negative, this is from the end of the array. The entire array is included if this isn't specified * @param {any} end - Element to end at, exclusive. If negative, it is relative to the end of the array. If not specified the whole array is included * @returns {any} An `ArrayBufferView` of the same type as this one, referencing the same data * @url http://www.espruino.com/Reference#l_ArrayBufferView_subarray */ - subarray(begin: number, end: any): ArrayBufferView; + subarray(begin?: number, end?: number): T; /** * Return the index of the value in the array, or `-1` @@ -5730,7 +6181,7 @@ declare class ArrayBufferView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_ArrayBufferView_indexOf */ - indexOf(value: any, startIndex: number): any; + indexOf(value: number, startIndex?: number): number; /** * Return `true` if the array includes the value, `false` otherwise @@ -5740,16 +6191,17 @@ declare class ArrayBufferView { * @returns {boolean} `true` if the array includes the value, `false` otherwise * @url http://www.espruino.com/Reference#l_ArrayBufferView_includes */ - includes(value: any, startIndex: number): boolean; + includes(value: number, startIndex?: number): boolean; /** - * Join all elements of this array together into one string, using 'separator' between them. eg. ```[1,2,3].join(' ')=='1 2 3'``` + * Join all elements of this array together into one string, using 'separator' + * between them. e.g. ```[1,2,3].join(' ')=='1 2 3'``` * * @param {any} separator - The separator * @returns {any} A String representing the Joined array * @url http://www.espruino.com/Reference#l_ArrayBufferView_join */ - join(separator: any): any; + join(separator?: string): string; /** * Do an in-place quicksort of the array @@ -5758,7 +6210,7 @@ declare class ArrayBufferView { * @returns {any} This array object * @url http://www.espruino.com/Reference#l_ArrayBufferView_sort */ - sort(variable: any): ArrayBufferView; + sort(compareFn?: (a: number, b: number) => number): this; /** * Executes a provided function once per array element. @@ -5767,17 +6219,19 @@ declare class ArrayBufferView { * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @url http://www.espruino.com/Reference#l_ArrayBufferView_forEach */ - forEach(func: any, thisArg: any): any; + forEach(callbackfn: (value: number, index: number, array: T) => void, thisArg?: any): void; /** - * Execute `previousValue=initialValue` and then `previousValue = callback(previousValue, currentValue, index, array)` for each element in the array, and finally return previousValue. + * Execute `previousValue=initialValue` and then `previousValue = + * callback(previousValue, currentValue, index, array)` for each element in the + * array, and finally return previousValue. * * @param {any} callback - Function used to reduce the array * @param {any} initialValue - if specified, the initial value to pass to the function * @returns {any} The value returned by the last function called * @url http://www.espruino.com/Reference#l_ArrayBufferView_reduce */ - reduce(callback: any, initialValue: any): any; + reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: T) => number, initialValue?: number): number; /** * Fill this array with the given value, for every index `>= start` and `< end` @@ -5788,42 +6242,45 @@ declare class ArrayBufferView { * @returns {any} This array * @url http://www.espruino.com/Reference#l_ArrayBufferView_fill */ - fill(value: any, start: number, end: any): ArrayBufferView; + fill(value: number, start?: number, end?: number): T; /** - * Return an array which contains only those elements for which the callback function returns 'true' + * Return an array which contains only those elements for which the callback + * function returns 'true' * * @param {any} function - Function to be executed * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @returns {any} An array containing the results * @url http://www.espruino.com/Reference#l_ArrayBufferView_filter */ - filter(func: any, thisArg: any): any; + filter(predicate: (value: number, index: number, array: T) => any, thisArg?: any): T; /** - * Return the array element where `function` returns `true`, or `undefined` if it doesn't returns `true` for any element. + * Return the array element where `function` returns `true`, or `undefined` if it + * doesn't returns `true` for any element. * * @param {any} function - Function to be executed * @returns {any} The array element where `function` returns `true`, or `undefined` * @url http://www.espruino.com/Reference#l_ArrayBufferView_find */ - find(func: any): any; + find(predicate: (value: number, index: number, obj: T) => boolean, thisArg?: any): number | undefined; /** - * Return the array element's index where `function` returns `true`, or `-1` if it doesn't returns `true` for any element. + * Return the array element's index where `function` returns `true`, or `-1` if it + * doesn't returns `true` for any element. * * @param {any} function - Function to be executed * @returns {any} The array element's index where `function` returns `true`, or `-1` * @url http://www.espruino.com/Reference#l_ArrayBufferView_findIndex */ - findIndex(func: any): any; + findIndex(predicate: (value: number, index: number, obj: T) => boolean, thisArg?: any): number; /** * Reverse the contents of this `ArrayBufferView` in-place * @returns {any} This array * @url http://www.espruino.com/Reference#l_ArrayBufferView_reverse */ - reverse(): ArrayBufferView; + reverse(): T /** * Return a copy of a portion of this array (in a new array). @@ -5834,12 +6291,17 @@ declare class ArrayBufferView { * @returns {any} A new array * @url http://www.espruino.com/Reference#l_ArrayBufferView_slice */ - slice(start: number, end: any): any[]; + slice(start?: number, end?: number): number[]; + + [index: number]: number } interface Uint8ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5848,25 +6310,23 @@ interface Uint8ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Uint8Array_Uint8Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Uint8Array; + new(array: ArrayLike): Uint8Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Uint8Array; } -interface Uint8Array { +type Uint8Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 8 bit unsigned integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Uint8Array - */ declare const Uint8Array: Uint8ArrayConstructor interface Uint8ClampedArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. - * Clamped arrays clamp their values to the allowed range, rather than 'wrapping'. e.g. after `a[0]=12345;`, `a[0]==255`. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. + * Clamped arrays clamp their values to the allowed range, rather than 'wrapping'. + * e.g. after `a[0]=12345;`, `a[0]==255`. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5875,24 +6335,21 @@ interface Uint8ClampedArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Uint8ClampedArray_Uint8ClampedArray */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Uint8ClampedArray; + new(array: ArrayLike): Uint8ClampedArray; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Uint8ClampedArray; } -interface Uint8ClampedArray { +type Uint8ClampedArray = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 8 bit unsigned integers that are automatically clamped to the range 0 to 255. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Uint8ClampedArray - */ declare const Uint8ClampedArray: Uint8ClampedArrayConstructor interface Int8ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5901,24 +6358,21 @@ interface Int8ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Int8Array_Int8Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Int8Array; + new(array: ArrayLike): Int8Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Int8Array; } -interface Int8Array { +type Int8Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 8 bit signed integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Int8Array - */ declare const Int8Array: Int8ArrayConstructor interface Uint16ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5927,24 +6381,21 @@ interface Uint16ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Uint16Array_Uint16Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Uint16Array; + new(array: ArrayLike): Uint16Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Uint16Array; } -interface Uint16Array { +type Uint16Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 16 bit unsigned integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Uint16Array - */ declare const Uint16Array: Uint16ArrayConstructor interface Int16ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5953,30 +6404,30 @@ interface Int16ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Int16Array_Int16Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Int16Array; + new(array: ArrayLike): Int16Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Int16Array; } -interface Int16Array { +type Int16Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 16 bit signed integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Int16Array - */ declare const Int16Array: Int16ArrayConstructor /** - * This is the built-in JavaScript class for a typed array of 24 bit unsigned integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) + * This is the built-in JavaScript class for a typed array of 24 bit unsigned + * integers. + * Instantiate this in order to efficiently store arrays of data (Espruino's normal + * arrays store data in a map, which is inefficient for non-sparse arrays). + * Arrays of this type include all the methods from + * [ArrayBufferView](/Reference#ArrayBufferView) * @url http://www.espruino.com/Reference#Uint24Array */ declare class Uint24Array { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -5985,14 +6436,19 @@ declare class Uint24Array { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Uint24Array_Uint24Array */ - static new(arr: any, byteOffset: number, length: number): ArrayBufferView; + static new(length: number): Uint24Array; + static new(array: ArrayLike): Uint24Array; + static new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Uint24Array; } interface Uint32ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -6001,24 +6457,21 @@ interface Uint32ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Uint32Array_Uint32Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Uint32Array; + new(array: ArrayLike): Uint32Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Uint32Array; } -interface Uint32Array { +type Uint32Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 32 bit unsigned integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Uint32Array - */ declare const Uint32Array: Uint32ArrayConstructor interface Int32ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -6027,24 +6480,21 @@ interface Int32ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Int32Array_Int32Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Int32Array; + new(array: ArrayLike): Int32Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Int32Array; } -interface Int32Array { +type Int32Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 32 bit signed integers. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Int32Array - */ declare const Int32Array: Int32ArrayConstructor interface Float32ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -6053,24 +6503,21 @@ interface Float32ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Float32Array_Float32Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Float32Array; + new(array: ArrayLike): Float32Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Float32Array; } -interface Float32Array { +type Float32Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 32 bit floating point values. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Float32Array - */ declare const Float32Array: Float32ArrayConstructor interface Float64ArrayConstructor { /** - * Create a typed array based on the given input. Either an existing Array Buffer, an Integer as a Length, or a simple array. If an `ArrayBufferView` (eg. `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied rather than referenced. + * Create a typed array based on the given input. Either an existing Array Buffer, + * an Integer as a Length, or a simple array. If an `ArrayBufferView` (e.g. + * `Uint8Array` rather than `ArrayBuffer`) is given, it will be completely copied + * rather than referenced. * @constructor * * @param {any} arr - The array or typed array to base this off, or an integer which is the array length @@ -6079,25 +6526,19 @@ interface Float64ArrayConstructor { * @returns {any} A typed array * @url http://www.espruino.com/Reference#l_Float64Array_Float64Array */ - new(arr: any, byteOffset: number, length: number): ArrayBufferView; + new(length: number): Float64Array; + new(array: ArrayLike): Float64Array; + new(buffer: ArrayBuffer, byteOffset?: number, length?: number): Float64Array; } -interface Float64Array { +type Float64Array = ArrayBufferView; -} - -/** - * This is the built-in JavaScript class for a typed array of 64 bit floating point values. - * Instantiate this in order to efficiently store arrays of data (Espruino's normal arrays store data in a map, which is inefficient for non-sparse arrays). - * Arrays of this type include all the methods from [ArrayBufferView](/Reference#ArrayBufferView) - * @url http://www.espruino.com/Reference#Float64Array - */ declare const Float64Array: Float64ArrayConstructor interface PromiseConstructor { /** - * Return a new promise that is resolved when all promises in the supplied - * array are resolved. + * Return a new promise that is resolved when all promises in the supplied array + * are resolved. * * @param {any} promises - An array of promises * @returns {any} A new Promise @@ -6106,8 +6547,7 @@ interface PromiseConstructor { all(promises: Promise[]): Promise; /** - * Return a new promise that is already resolved (at idle it'll - * call `.then`) + * Return a new promise that is already resolved (at idle it'll call `.then`) * * @param {any} promises - Data to pass to the `.then` handler * @returns {any} A new Promise @@ -6116,8 +6556,7 @@ interface PromiseConstructor { resolve(promises: T): Promise; /** - * Return a new promise that is already rejected (at idle it'll - * call `.catch`) + * Return a new promise that is already rejected (at idle it'll call `.catch`) * * @param {any} promises - Data to pass to the `.catch` handler * @returns {any} A new Promise @@ -6126,8 +6565,8 @@ interface PromiseConstructor { reject(promises: any): any; /** - * Create a new Promise. The executor function is executed immediately (before the constructor even returns) - * and + * Create a new Promise. The executor function is executed immediately (before the + * constructor even returns) and * @constructor * * @param {any} executor - A function of the form `function (resolve, reject)` @@ -6163,7 +6602,8 @@ interface Promise { declare const Promise: PromiseConstructor /** - * This class allows use of the built-in SPI ports. Currently it is SPI master only. + * This class allows use of the built-in SPI ports. Currently it is SPI master + * only. * @url http://www.espruino.com/Reference#SPI */ declare class SPI { @@ -6178,7 +6618,8 @@ declare class SPI { static find(pin: Pin): any; /** - * Create a software SPI port. This has limited functionality (no baud rate), but it can work on any pins. + * Create a software SPI port. This has limited functionality (no baud rate), but + * it can work on any pins. * Use `SPI.setup` to configure this port. * @constructor * @returns {any} A SPI object @@ -6200,20 +6641,33 @@ declare class SPI { * bits:8 // only available for software SPI * } * ``` - * If `sck`,`miso` and `mosi` are left out, they will automatically be chosen. However if one or more is specified then the unspecified pins will not be set up. - * You can find out which pins to use by looking at [your board's reference page](#boards) and searching for pins with the `SPI` marker. Some boards such as those based on `nRF52` chips can have SPI on any pins, so don't have specific markings. - * The SPI `mode` is between 0 and 3 - see http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase - * On STM32F1-based parts, you cannot mix AF and non-AF pins (SPI pins are usually grouped on the chip - and you can't mix pins from two groups). Espruino will not warn you about this. + * If `sck`,`miso` and `mosi` are left out, they will automatically be chosen. + * However if one or more is specified then the unspecified pins will not be set + * up. + * You can find out which pins to use by looking at [your board's reference + * page](#boards) and searching for pins with the `SPI` marker. Some boards such as + * those based on `nRF52` chips can have SPI on any pins, so don't have specific + * markings. + * The SPI `mode` is between 0 and 3 - see + * http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase + * On STM32F1-based parts, you cannot mix AF and non-AF pins (SPI pins are usually + * grouped on the chip - and you can't mix pins from two groups). Espruino will not + * warn you about this. * * @param {any} options - An Object containing extra information on initialising the SPI port * @url http://www.espruino.com/Reference#l_SPI_setup */ - setup(options: any): any; + setup(options: any): void; /** - * Send data down SPI, and return the result. Sending an integer will return an integer, a String will return a String, and anything else will return a Uint8Array. - * Sending multiple bytes in one call to send is preferable as they can then be transmitted end to end. Using multiple calls to send() will result in significantly slower transmission speeds. - * For maximum speeds, please pass either Strings or Typed Arrays as arguments. Note that you can even pass arrays of arrays, like `[1,[2,3,4],5]` + * Send data down SPI, and return the result. Sending an integer will return an + * integer, a String will return a String, and anything else will return a + * Uint8Array. + * Sending multiple bytes in one call to send is preferable as they can then be + * transmitted end to end. Using multiple calls to send() will result in + * significantly slower transmission speeds. + * For maximum speeds, please pass either Strings or Typed Arrays as arguments. + * Note that you can even pass arrays of arrays, like `[1,[2,3,4],5]` * * @param {any} data - The data to send - either an Integer, Array, String, or Object of the form `{data: ..., count:#}` * @param {Pin} nss_pin - An nSS pin - this will be lowered before SPI output and raised afterwards (optional). There will be a small delay between when this is lowered and when sending starts, and also between sending finishing and it being raised. @@ -6223,7 +6677,8 @@ declare class SPI { send(data: any, nss_pin: Pin): any; /** - * Write a character or array of characters to SPI - without reading the result back. + * Write a character or array of characters to SPI - without reading the result + * back. * For maximum speeds, please pass either Strings or Typed Arrays as arguments. * * @param {any} data @@ -6231,11 +6686,14 @@ declare class SPI { * If the last argument is a pin, it is taken to be the NSS pin * @url http://www.espruino.com/Reference#l_SPI_write */ - write(...data: any[]): any; + write(...data: any[]): void; /** - * Send data down SPI, using 4 bits for each 'real' bit (MSB first). This can be useful for faking one-wire style protocols - * Sending multiple bytes in one call to send is preferable as they can then be transmitted end to end. Using multiple calls to send() will result in significantly slower transmission speeds. + * Send data down SPI, using 4 bits for each 'real' bit (MSB first). This can be + * useful for faking one-wire style protocols + * Sending multiple bytes in one call to send is preferable as they can then be + * transmitted end to end. Using multiple calls to send() will result in + * significantly slower transmission speeds. * * @param {any} data - The data to send - either an integer, array, or string * @param {number} bit0 - The 4 bits to send for a 0 (MSB first) @@ -6243,11 +6701,14 @@ declare class SPI { * @param {Pin} nss_pin - An nSS pin - this will be lowered before SPI output and raised afterwards (optional). There will be a small delay between when this is lowered and when sending starts, and also between sending finishing and it being raised. * @url http://www.espruino.com/Reference#l_SPI_send4bit */ - send4bit(data: any, bit0: number, bit1: number, nss_pin: Pin): any; + send4bit(data: any, bit0: number, bit1: number, nss_pin: Pin): void; /** - * Send data down SPI, using 8 bits for each 'real' bit (MSB first). This can be useful for faking one-wire style protocols - * Sending multiple bytes in one call to send is preferable as they can then be transmitted end to end. Using multiple calls to send() will result in significantly slower transmission speeds. + * Send data down SPI, using 8 bits for each 'real' bit (MSB first). This can be + * useful for faking one-wire style protocols + * Sending multiple bytes in one call to send is preferable as they can then be + * transmitted end to end. Using multiple calls to send() will result in + * significantly slower transmission speeds. * * @param {any} data - The data to send - either an integer, array, or string * @param {number} bit0 - The 8 bits to send for a 0 (MSB first) @@ -6255,12 +6716,14 @@ declare class SPI { * @param {Pin} nss_pin - An nSS pin - this will be lowered before SPI output and raised afterwards (optional). There will be a small delay between when this is lowered and when sending starts, and also between sending finishing and it being raised * @url http://www.espruino.com/Reference#l_SPI_send8bit */ - send8bit(data: any, bit0: number, bit1: number, nss_pin: Pin): any; + send8bit(data: any, bit0: number, bit1: number, nss_pin: Pin): void; } /** - * This class allows use of the built-in I2C ports. Currently it allows I2C Master mode only. - * All addresses are in 7 bit format. If you have an 8 bit address then you need to shift it one bit to the right. + * This class allows use of the built-in I2C ports. Currently it allows I2C Master + * mode only. + * All addresses are in 7 bit format. If you have an 8 bit address then you need to + * shift it one bit to the right. * @url http://www.espruino.com/Reference#I2C */ declare class I2C { @@ -6275,7 +6738,8 @@ declare class I2C { static find(pin: Pin): any; /** - * Create a software I2C port. This has limited functionality (no baud rate), but it can work on any pins. + * Create a software I2C port. This has limited functionality (no baud rate), but + * it can work on any pins. * Use `I2C.setup` to configure this port. * @constructor * @returns {any} An I2C object @@ -6285,7 +6749,8 @@ declare class I2C { /** * Set up this I2C port - * If not specified in options, the default pins are used (usually the lowest numbered pins on the lowest port that supports this peripheral) + * If not specified in options, the default pins are used (usually the lowest + * numbered pins on the lowest port that supports this peripheral) * * @param {any} options * An optional structure containing extra information on initialising the I2C port @@ -6293,19 +6758,22 @@ declare class I2C { * You can find out which pins to use by looking at [your board's reference page](#boards) and searching for pins with the `I2C` marker. Note that 400kHz is the maximum bitrate for most parts. * @url http://www.espruino.com/Reference#l_I2C_setup */ - setup(options: any): any; + setup(options: any): void; /** - * Transmit to the slave device with the given address. This is like Arduino's beginTransmission, write, and endTransmission rolled up into one. + * Transmit to the slave device with the given address. This is like Arduino's + * beginTransmission, write, and endTransmission rolled up into one. * * @param {any} address - The 7 bit address of the device to transmit to, or an object of the form `{address:12, stop:false}` to send this data without a STOP signal. * @param {any} data - One or more items to write. May be ints, strings, arrays, or special objects (see `E.toUint8Array` for more info). * @url http://www.espruino.com/Reference#l_I2C_writeTo */ - writeTo(address: any, ...data: any[]): any; + writeTo(address: any, ...data: any[]): void; /** - * Request bytes from the given slave device, and return them as a Uint8Array (packed array of bytes). This is like using Arduino Wire's requestFrom, available and read functions. Sends a STOP + * Request bytes from the given slave device, and return them as a Uint8Array + * (packed array of bytes). This is like using Arduino Wire's requestFrom, + * available and read functions. Sends a STOP * * @param {any} address - The 7 bit address of the device to request bytes from, or an object of the form `{address:12, stop:false}` to send this data without a STOP signal. * @param {number} quantity - The number of bytes to request @@ -6316,13 +6784,18 @@ declare class I2C { } /** - * This class handles waveforms. In Espruino, a Waveform is a set of data that you want to input or output. + * This class handles waveforms. In Espruino, a Waveform is a set of data that you + * want to input or output. * @url http://www.espruino.com/Reference#Waveform */ declare class Waveform { /** - * Create a waveform class. This allows high speed input and output of waveforms. It has an internal variable called `buffer` (as well as `buffer2` when double-buffered - see `options` below) which contains the data to input/output. - * When double-buffered, a 'buffer' event will be emitted each time a buffer is finished with (the argument is that buffer). When the recording stops, a 'finish' event will be emitted (with the first argument as the buffer). + * Create a waveform class. This allows high speed input and output of waveforms. + * It has an internal variable called `buffer` (as well as `buffer2` when + * double-buffered - see `options` below) which contains the data to input/output. + * When double-buffered, a 'buffer' event will be emitted each time a buffer is + * finished with (the argument is that buffer). When the recording stops, a + * 'finish' event will be emitted (with the first argument as the buffer). * @constructor * * @param {number} samples - The number of samples @@ -6333,35 +6806,39 @@ declare class Waveform { static new(samples: number, options: any): any; /** - * Will start outputting the waveform on the given pin - the pin must have previously been initialised with analogWrite. If not repeating, it'll emit a `finish` event when it is done. + * Will start outputting the waveform on the given pin - the pin must have + * previously been initialised with analogWrite. If not repeating, it'll emit a + * `finish` event when it is done. * * @param {Pin} output - The pin to output on * @param {number} freq - The frequency to output each sample at * @param {any} options - Optional options struct `{time:float,repeat:bool}` where: `time` is the that the waveform with start output at, e.g. `getTime()+1` (otherwise it is immediate), `repeat` is a boolean specifying whether to repeat the give sample * @url http://www.espruino.com/Reference#l_Waveform_startOutput */ - startOutput(output: Pin, freq: number, options: any): any; + startOutput(output: Pin, freq: number, options: any): void; /** - * Will start inputting the waveform on the given pin that supports analog. If not repeating, it'll emit a `finish` event when it is done. + * Will start inputting the waveform on the given pin that supports analog. If not + * repeating, it'll emit a `finish` event when it is done. * * @param {Pin} output - The pin to output on * @param {number} freq - The frequency to output each sample at * @param {any} options - Optional options struct `{time:float,repeat:bool}` where: `time` is the that the waveform with start output at, e.g. `getTime()+1` (otherwise it is immediate), `repeat` is a boolean specifying whether to repeat the give sample * @url http://www.espruino.com/Reference#l_Waveform_startInput */ - startInput(output: Pin, freq: number, options: any): any; + startInput(output: Pin, freq: number, options: any): void; /** * Stop a waveform that is currently outputting * @url http://www.espruino.com/Reference#l_Waveform_stop */ - stop(): any; + stop(): void; } /** * This is the built-in class for Pins, such as D0,D1,LED1, or BTN - * You can call the methods on Pin, or you can use Wiring-style functions such as digitalWrite + * You can call the methods on Pin, or you can use Wiring-style functions such as + * digitalWrite * @url http://www.espruino.com/Reference#Pin */ declare class Pin { @@ -6377,7 +6854,8 @@ declare class Pin { /** * Returns the input state of the pin as a boolean. - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset the pin's state to `"input"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset the pin's state to `"input"` * @returns {boolean} Whether pin is a logical 1 or 0 * @url http://www.espruino.com/Reference#l_Pin_read */ @@ -6385,36 +6863,40 @@ declare class Pin { /** * Sets the output state of the pin to a 1 - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset the pin's state to `"output"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset the pin's state to `"output"` * @url http://www.espruino.com/Reference#l_Pin_set */ - set(): any; + set(): void; /** * Sets the output state of the pin to a 0 - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset the pin's state to `"output"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset the pin's state to `"output"` * @url http://www.espruino.com/Reference#l_Pin_reset */ - reset(): any; + reset(): void; /** * Sets the output state of the pin to the parameter given - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset the pin's state to `"output"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset the pin's state to `"output"` * * @param {boolean} value - Whether to set output high (true/1) or low (false/0) * @url http://www.espruino.com/Reference#l_Pin_write */ - write(value: boolean): any; + write(value: boolean): void; /** * Sets the output state of the pin to the parameter given at the specified time. - * **Note:** this **doesn't** change the mode of the pin to an output. To do that, you need to use `pin.write(0)` or `pinMode(pin, 'output')` first. + * **Note:** this **doesn't** change the mode of the pin to an output. To do that, + * you need to use `pin.write(0)` or `pinMode(pin, 'output')` first. * * @param {boolean} value - Whether to set output high (true/1) or low (false/0) * @param {number} time - Time at which to write * @url http://www.espruino.com/Reference#l_Pin_writeAtTime */ - writeAtTime(value: boolean, time: number): any; + writeAtTime(value: boolean, time: number): void; /** * Return the current mode of the given pin. See `pinMode` for more information. @@ -6424,17 +6906,19 @@ declare class Pin { getMode(): any; /** - * Set the mode of the given pin. See [`pinMode`](#l__global_pinMode) for more information on pin modes. + * Set the mode of the given pin. See [`pinMode`](#l__global_pinMode) for more + * information on pin modes. * * @param {any} mode - The mode - a string that is either 'analog', 'input', 'input_pullup', 'input_pulldown', 'output', 'opendrain', 'af_output' or 'af_opendrain'. Do not include this argument if you want to revert to automatic pin mode setting. * @url http://www.espruino.com/Reference#l_Pin_mode */ - mode(mode: any): any; + mode(mode: any): void; /** * Toggles the state of the pin from off to on, or from on to off. * **Note:** This method doesn't currently work on the ESP8266 port of Espruino. - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset the pin's state to `"output"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset the pin's state to `"output"` * @returns {boolean} True if the pin is high after calling the function * @url http://www.espruino.com/Reference#l_Pin_toggle */ @@ -6464,7 +6948,8 @@ declare class Pin { interface DataViewConstructor { /** - * Create a `DataView` object that can be used to access the data in an `ArrayBuffer`. + * Create a `DataView` object that can be used to access the data in an + * `ArrayBuffer`. * ``` * var b = new ArrayBuffer(8) * var v = new DataView(b) @@ -6481,7 +6966,7 @@ interface DataViewConstructor { * @returns {any} A `DataView` object * @url http://www.espruino.com/Reference#l_DataView_DataView */ - new(buffer: any, byteOffset: number, byteLength: number): DataView; + new(buffer: ArrayBuffer, byteOffset?: number, byteLength?: number): DataView; } interface DataView { @@ -6492,7 +6977,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getFloat32 */ - getFloat32(byteOffset: number, littleEndian: boolean): any; + getFloat32(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6501,7 +6986,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getFloat64 */ - getFloat64(byteOffset: number, littleEndian: boolean): any; + getFloat64(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6510,7 +6995,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getInt8 */ - getInt8(byteOffset: number, littleEndian: boolean): any; + getInt8(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6519,7 +7004,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getInt16 */ - getInt16(byteOffset: number, littleEndian: boolean): any; + getInt16(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6528,7 +7013,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getInt32 */ - getInt32(byteOffset: number, littleEndian: boolean): any; + getInt32(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6537,7 +7022,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getUint8 */ - getUint8(byteOffset: number, littleEndian: boolean): any; + getUint8(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6546,7 +7031,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getUint16 */ - getUint16(byteOffset: number, littleEndian: boolean): any; + getUint16(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6555,7 +7040,7 @@ interface DataView { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_DataView_getUint32 */ - getUint32(byteOffset: number, littleEndian: boolean): any; + getUint32(byteOffset: number, littleEndian?: boolean): number; /** * @@ -6564,7 +7049,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setFloat32 */ - setFloat32(byteOffset: number, value: any, littleEndian: boolean): any; + setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6573,7 +7058,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setFloat64 */ - setFloat64(byteOffset: number, value: any, littleEndian: boolean): any; + setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6582,7 +7067,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setInt8 */ - setInt8(byteOffset: number, value: any, littleEndian: boolean): any; + setInt8(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6591,7 +7076,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setInt16 */ - setInt16(byteOffset: number, value: any, littleEndian: boolean): any; + setInt16(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6600,7 +7085,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setInt32 */ - setInt32(byteOffset: number, value: any, littleEndian: boolean): any; + setInt32(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6609,7 +7094,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setUint8 */ - setUint8(byteOffset: number, value: any, littleEndian: boolean): any; + setUint8(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6618,7 +7103,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setUint16 */ - setUint16(byteOffset: number, value: any, littleEndian: boolean): any; + setUint16(byteOffset: number, value: number, littleEndian?: boolean): void; /** * @@ -6627,7 +7112,7 @@ interface DataView { * @param {boolean} littleEndian - (optional) Whether to read in little endian - if false or undefined data is read as big endian * @url http://www.espruino.com/Reference#l_DataView_setUint32 */ - setUint32(byteOffset: number, value: any, littleEndian: boolean): any; + setUint32(byteOffset: number, value: number, littleEndian?: boolean): void; } /** @@ -6638,12 +7123,17 @@ declare const DataView: DataViewConstructor /** * This class allows use of the built-in USARTs - * Methods may be called on the `USB`, `Serial1`, `Serial2`, `Serial3`, `Serial4`, `Serial5` and `Serial6` objects. While different processors provide different numbers of USARTs, on official Espruino boards you can always rely on at least `Serial1` being available + * Methods may be called on the `USB`, `Serial1`, `Serial2`, `Serial3`, `Serial4`, + * `Serial5` and `Serial6` objects. While different processors provide different + * numbers of USARTs, on official Espruino boards you can always rely on at least + * `Serial1` being available * @url http://www.espruino.com/Reference#Serial */ declare class Serial { /** - * The `data` event is called when data is received. If a handler is defined with `X.on('data', function(data) { ... })` then it will be called, otherwise data will be stored in an internal buffer, where it can be retrieved with `X.read()` + * The `data` event is called when data is received. If a handler is defined with + * `X.on('data', function(data) { ... })` then it will be called, otherwise data + * will be stored in an internal buffer, where it can be retrieved with `X.read()` * @param {string} event - The event to listen to. * @param {(data: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `data` A string containing one or more characters of received data @@ -6653,13 +7143,14 @@ declare class Serial { /** * The `framing` event is called when there was activity on the input to the UART - * but the `STOP` bit wasn't in the correct place. This is either because there - * was noise on the line, or the line has been pulled to 0 for a long period - * of time. - * To enable this, you must initialise Serial with `SerialX.setup(..., { ..., errors:true });` + * but the `STOP` bit wasn't in the correct place. This is either because there was + * noise on the line, or the line has been pulled to 0 for a long period of time. + * To enable this, you must initialise Serial with `SerialX.setup(..., { ..., + * errors:true });` * **Note:** Even though there was an error, the byte will still be received and * passed to the `data` handler. - * **Note:** This only works on STM32 and NRF52 based devices (eg. all official Espruino boards) + * **Note:** This only works on STM32 and NRF52 based devices (eg. all official + * Espruino boards) * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Serial_framing @@ -6667,12 +7158,14 @@ declare class Serial { static on(event: "framing", callback: () => void): void; /** - * The `parity` event is called when the UART was configured with a parity bit, - * and this doesn't match the bits that have actually been received. - * To enable this, you must initialise Serial with `SerialX.setup(..., { ..., errors:true });` + * The `parity` event is called when the UART was configured with a parity bit, and + * this doesn't match the bits that have actually been received. + * To enable this, you must initialise Serial with `SerialX.setup(..., { ..., + * errors:true });` * **Note:** Even though there was an error, the byte will still be received and * passed to the `data` handler. - * **Note:** This only works on STM32 and NRF52 based devices (eg. all official Espruino boards) + * **Note:** This only works on STM32 and NRF52 based devices (eg. all official + * Espruino boards) * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Serial_parity @@ -6680,7 +7173,8 @@ declare class Serial { static on(event: "parity", callback: () => void): void; /** - * Try and find a USART (Serial) hardware device that will work on this pin (eg. `Serial1`) + * Try and find a USART (Serial) hardware device that will work on this pin (eg. + * `Serial1`) * May return undefined if no device can be found. * * @param {Pin} pin - A pin to search with @@ -6690,7 +7184,8 @@ declare class Serial { static find(pin: Pin): any; /** - * Create a software Serial port. This has limited functionality (only low baud rates), but it can work on any pins. + * Create a software Serial port. This has limited functionality (only low baud + * rates), but it can work on any pins. * Use `Serial.setup` to configure this port. * @constructor * @returns {any} A Serial object @@ -6700,14 +7195,14 @@ declare class Serial { /** * Set this Serial port as the port for the JavaScript console (REPL). - * Unless `force` is set to true, changes in the connection state of the board - * (for instance plugging in USB) will cause the console to change. + * Unless `force` is set to true, changes in the connection state of the board (for + * instance plugging in USB) will cause the console to change. * See `E.setConsole` for a more flexible version of this function. * * @param {boolean} force - Whether to force the console to this port * @url http://www.espruino.com/Reference#l_Serial_setConsole */ - setConsole(force: boolean): any; + setConsole(force: boolean): void; /** * Setup this Serial port with the given baud rate and options. @@ -6731,72 +7226,77 @@ declare class Serial { * errors:false // (default false) whether to forward framing/parity errors * } * ``` - * You can find out which pins to use by looking at [your board's reference page](#boards) - * and searching for pins with the `UART`/`USART` markers. - * If not specified in options, the default pins are used for rx and tx - * (usually the lowest numbered pins on the lowest port that supports - * this peripheral). `ck` and `cts` are not used unless specified. + * You can find out which pins to use by looking at [your board's reference + * page](#boards) and searching for pins with the `UART`/`USART` markers. + * If not specified in options, the default pins are used for rx and tx (usually + * the lowest numbered pins on the lowest port that supports this peripheral). `ck` + * and `cts` are not used unless specified. * Note that even after changing the RX and TX pins, if you have called setup * before then the previous RX and TX pins will still be connected to the Serial * port as well - until you set them to something else using `digitalWrite` or * `pinMode`. - * Flow control can be xOn/xOff (`flow:'xon'`) or hardware flow control - * (receive only) if `cts` is specified. If `cts` is set to a pin, the - * pin's value will be 0 when Espruino is ready for data and 1 when it isn't. + * Flow control can be xOn/xOff (`flow:'xon'`) or hardware flow control (receive + * only) if `cts` is specified. If `cts` is set to a pin, the pin's value will be 0 + * when Espruino is ready for data and 1 when it isn't. * By default, framing or parity errors don't create `framing` or `parity` events - * on the `Serial` object because storing these errors uses up additional - * storage in the queue. If you're intending to receive a lot of malformed - * data then the queue might overflow `E.getErrorFlags()` would return `FIFO_FULL`. - * However if you need to respond to `framing` or `parity` errors then - * you'll need to use `errors:true` when initialising serial. - * On Linux builds there is no default Serial device, so you must specify - * a path to a device - for instance: `Serial1.setup(9600,{path:"/dev/ttyACM0"})` + * on the `Serial` object because storing these errors uses up additional storage + * in the queue. If you're intending to receive a lot of malformed data then the + * queue might overflow `E.getErrorFlags()` would return `FIFO_FULL`. However if + * you need to respond to `framing` or `parity` errors then you'll need to use + * `errors:true` when initialising serial. + * On Linux builds there is no default Serial device, so you must specify a path to + * a device - for instance: `Serial1.setup(9600,{path:"/dev/ttyACM0"})` * You can also set up 'software serial' using code like: * ``` * var s = new Serial(); * s.setup(9600,{rx:a_pin, tx:a_pin}); * ``` - * However software serial doesn't use `ck`, `cts`, `parity`, `flow` or `errors` parts of the initialisation object. + * However software serial doesn't use `ck`, `cts`, `parity`, `flow` or `errors` + * parts of the initialisation object. * * @param {any} baudrate - The baud rate - the default is 9600 * @param {any} options - An optional structure containing extra information on initialising the serial port - see below. * @url http://www.espruino.com/Reference#l_Serial_setup */ - setup(baudrate: any, options: any): any; + setup(baudrate: any, options: any): void; /** - * If the serial (or software serial) device was set up, - * uninitialise it. + * If the serial (or software serial) device was set up, uninitialise it. * @url http://www.espruino.com/Reference#l_Serial_unsetup */ - unsetup(): any; + unsetup(): void; /** * Print a string to the serial port - without a line feed - * **Note:** This function replaces any occurances of `\n` in the string with `\r\n`. To avoid this, use `Serial.write`. + * **Note:** This function replaces any occurances of `\n` in the string with + * `\r\n`. To avoid this, use `Serial.write`. * * @param {any} string - A String to print * @url http://www.espruino.com/Reference#l_Serial_print */ - print(string: any): any; + print(string: any): void; /** * Print a line to the serial port with a newline (`\r\n`) at the end of it. - * **Note:** This function converts data to a string first, eg `Serial.print([1,2,3])` is equivalent to `Serial.print("1,2,3"). If you'd like to write raw bytes, use `Serial.write`. + * **Note:** This function converts data to a string first, eg + * `Serial.print([1,2,3])` is equivalent to `Serial.print("1,2,3"). If you'd like + * to write raw bytes, use `Serial.write`. * * @param {any} string - A String to print * @url http://www.espruino.com/Reference#l_Serial_println */ - println(string: any): any; + println(string: any): void; /** * Write a character or array of data to the serial port - * This method writes unmodified data, eg `Serial.write([1,2,3])` is equivalent to `Serial.write("\1\2\3")`. If you'd like data converted to a string first, use `Serial.print`. + * This method writes unmodified data, eg `Serial.write([1,2,3])` is equivalent to + * `Serial.write("\1\2\3")`. If you'd like data converted to a string first, use + * `Serial.print`. * * @param {any} data - One or more items to write. May be ints, strings, arrays, or special objects (see `E.toUint8Array` for more info). * @url http://www.espruino.com/Reference#l_Serial_write */ - write(...data: any[]): any; + write(...data: any[]): void; /** * Add data to this device as if it came directly from the input - it will be @@ -6806,16 +7306,17 @@ declare class Serial { * Serial1.inject('Hello World'); * // prints "Got Hel","Got lo World" (characters can be split over multiple callbacks) * ``` - * This is most useful if you wish to send characters to Espruino's - * REPL (console) while it is on another device. + * This is most useful if you wish to send characters to Espruino's REPL (console) + * while it is on another device. * * @param {any} data - One or more items to write. May be ints, strings, arrays, or special objects (see `E.toUint8Array` for more info). * @url http://www.espruino.com/Reference#l_Serial_inject */ - inject(...data: any[]): any; + inject(...data: any[]): void; /** - * Return how many bytes are available to read. If there is already a listener for data, this will always return 0. + * Return how many bytes are available to read. If there is already a listener for + * data, this will always return 0. * @returns {number} How many bytes are available * @url http://www.espruino.com/Reference#l_Serial_available */ @@ -6841,23 +7342,21 @@ declare class Serial { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_Serial_pipe */ - pipe(destination: any, options: any): any; + pipe(destination: any, options: any): void; } /** - * These objects are created from `require("Storage").open` - * and allow Storage items to be read/written. - * The `Storage` library writes into Flash memory (which - * can only be erased in chunks), and unlike a normal filesystem - * it allocates files in one long contiguous area to allow them - * to be accessed easily from Espruino. - * This presents a challenge for `StorageFile` which allows you - * to append to a file, so instead `StorageFile` stores files - * in chunks. It uses the last character of the filename - * to denote the chunk number (eg `"foobar\1"`, `"foobar\2"`, etc). - * This means that while `StorageFile` files exist in the same - * area as those from `Storage`, they should be - * read using `Storage.open` (and not `Storage.read`). + * These objects are created from `require("Storage").open` and allow Storage items + * to be read/written. + * The `Storage` library writes into Flash memory (which can only be erased in + * chunks), and unlike a normal filesystem it allocates files in one long + * contiguous area to allow them to be accessed easily from Espruino. + * This presents a challenge for `StorageFile` which allows you to append to a + * file, so instead `StorageFile` stores files in chunks. It uses the last + * character of the filename to denote the chunk number (eg `"foobar\1"`, + * `"foobar\2"`, etc). + * This means that while `StorageFile` files exist in the same area as those from + * `Storage`, they should be read using `Storage.open` (and not `Storage.read`). * ``` * f = s.open("foobar","w"); * f.write("Hell"); @@ -6882,61 +7381,65 @@ declare class Serial { * // now get rid of file * f.erase(); * ``` - * **Note:** `StorageFile` uses the fact that all bits of erased flash memory - * are 1 to detect the end of a file. As such you should not write character - * code 255 (`"\xFF"`) to these files. + * **Note:** `StorageFile` uses the fact that all bits of erased flash memory are 1 + * to detect the end of a file. As such you should not write character code 255 + * (`"\xFF"`) to these files. * @url http://www.espruino.com/Reference#StorageFile */ declare class StorageFile { /** - * Read 'len' bytes of data from the file, and return a String containing those bytes. - * If the end of the file is reached, the String may be smaller than the amount of bytes - * requested, or if the file is already at the end, `undefined` is returned. + * Read 'len' bytes of data from the file, and return a String containing those + * bytes. + * If the end of the file is reached, the String may be smaller than the amount of + * bytes requested, or if the file is already at the end, `undefined` is returned. * * @param {number} len - How many bytes to read * @returns {any} A String, or undefined * @url http://www.espruino.com/Reference#l_StorageFile_read */ - read(len: number): String; + read(len: number): string; /** * Read a line of data from the file (up to and including `"\n"`) * @returns {any} A line of data * @url http://www.espruino.com/Reference#l_StorageFile_readLine */ - readLine(): String; + readLine(): string; /** * Return the length of the current file. - * This requires Espruino to read the file from scratch, - * which is not a fast operation. + * This requires Espruino to read the file from scratch, which is not a fast + * operation. * @returns {number} The current length in bytes of the file * @url http://www.espruino.com/Reference#l_StorageFile_getLength */ getLength(): number; /** - * Append the given data to a file. You should not attempt to append `"\xFF"` (character code 255). + * Append the given data to a file. You should not attempt to append `"\xFF"` + * (character code 255). * * @param {any} data - The data to write. This should not include `'\xFF'` (character code 255) * @url http://www.espruino.com/Reference#l_StorageFile_write */ - write(data: any): any; + write(data: string): void; /** * Erase this file * @url http://www.espruino.com/Reference#l_StorageFile_erase */ - erase(): any; + erase(): void; } interface processConstructor { /** - * This event is called when an exception gets thrown and isn't caught (eg. it gets all the way back to the event loop). - * You can use this for logging potential problems that might occur during execution when you - * might not be able to see what is written to the console, for example: + * This event is called when an exception gets thrown and isn't caught (eg. it gets + * all the way back to the event loop). + * You can use this for logging potential problems that might occur during + * execution when you might not be able to see what is written to the console, for + * example: * ``` * var lastError; * process.on('uncaughtException', function(e) { @@ -6948,8 +7451,8 @@ interface processConstructor { * print(lastError,lastError.stack?"\n"+lastError.stack:"") * } * ``` - * **Note:** When this is used, exceptions will cease to be reported on the console - which - * may make debugging difficult! + * **Note:** When this is used, exceptions will cease to be reported on the + * console - which may make debugging difficult! * @param {string} event - The event to listen to. * @param {(exception: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `exception` The uncaught exception @@ -6972,34 +7475,51 @@ interface processConstructor { * * `RAM` - total amount of on-chip RAM in bytes * * `FLASH` - total amount of on-chip flash memory in bytes * * `SPIFLASH` - (on Bangle.js) total amount of off-chip flash memory in bytes - * * `HWVERSION` - For Puck.js this is the board revision (1, 2, 2.1), or for Bangle.js it's 1 or 2 + * * `HWVERSION` - For Puck.js this is the board revision (1, 2, 2.1), or for + * Bangle.js it's 1 or 2 * * `STORAGE` - memory in bytes dedicated to the `Storage` module * * `SERIAL` - the serial number of this chip - * * `CONSOLE` - the name of the current console device being used (`Serial1`, `USB`, `Bluetooth`, etc) + * * `CONSOLE` - the name of the current console device being used (`Serial1`, + * `USB`, `Bluetooth`, etc) * * `MODULES` - a list of built-in modules separated by commas - * * `EXPTR` - The address of the `exportPtrs` structure in flash (this includes links to built-in functions that compiled JS code needs) - * * `APP_RAM_BASE` - On nRF5x boards, this is the RAM required by the Softdevice *if it doesn't exactly match what was allocated*. You can use this to update `LD_APP_RAM_BASE` in the `BOARD.py` file - * For example, to get a list of built-in modules, you can use `process.env.MODULES.split(',')` + * * `EXPTR` - The address of the `exportPtrs` structure in flash (this includes + * links to built-in functions that compiled JS code needs) + * * `APP_RAM_BASE` - On nRF5x boards, this is the RAM required by the Softdevice + * *if it doesn't exactly match what was allocated*. You can use this to update + * `LD_APP_RAM_BASE` in the `BOARD.py` file + * For example, to get a list of built-in modules, you can use + * `process.env.MODULES.split(',')` * @returns {any} An object * @url http://www.espruino.com/Reference#l_process_env */ env: any; /** - * Run a Garbage Collection pass, and return an object containing information on memory usage. - * * `free` : Memory that is available to be used (in blocks) + * Run a Garbage Collection pass, and return an object containing information on + * memory usage. + * * `free` : Memory that is available to be used (in blocks) * * `usage` : Memory that has been used (in blocks) * * `total` : Total memory (in blocks) - * * `history` : Memory used for command history - that is freed if memory is low. Note that this is INCLUDED in the figure for 'free' - * * `gc` : Memory freed during the GC pass - * * `gctime` : Time taken for GC pass (in milliseconds) + * * `history` : Memory used for command history - that is freed if memory is low. + * Note that this is INCLUDED in the figure for 'free' + * * `gc` : Memory freed during the GC pass + * * `gctime` : Time taken for GC pass (in milliseconds) * * `blocksize` : Size of a block (variable) in bytes - * * `stackEndAddress` : (on ARM) the address (that can be used with peek/poke/etc) of the END of the stack. The stack grows down, so unless you do a lot of recursion the bytes above this can be used. - * * `flash_start` : (on ARM) the address of the start of flash memory (usually `0x8000000`) - * * `flash_binary_end` : (on ARM) the address in flash memory of the end of Espruino's firmware. - * * `flash_code_start` : (on ARM) the address in flash memory of pages that store any code that you save with `save()`. - * * `flash_length` : (on ARM) the amount of flash memory this firmware was built for (in bytes). **Note:** Some STM32 chips actually have more memory than is advertised. - * Memory units are specified in 'blocks', which are around 16 bytes each (depending on your device). The actual size is available in `blocksize`. See http://www.espruino.com/Performance for more information. + * * `stackEndAddress` : (on ARM) the address (that can be used with peek/poke/etc) + * of the END of the stack. The stack grows down, so unless you do a lot of + * recursion the bytes above this can be used. + * * `flash_start` : (on ARM) the address of the start of flash memory (usually + * `0x8000000`) + * * `flash_binary_end` : (on ARM) the address in flash memory of the end of + * Espruino's firmware. + * * `flash_code_start` : (on ARM) the address in flash memory of pages that store + * any code that you save with `save()`. + * * `flash_length` : (on ARM) the amount of flash memory this firmware was built + * for (in bytes). **Note:** Some STM32 chips actually have more memory than is + * advertised. + * Memory units are specified in 'blocks', which are around 16 bytes each + * (depending on your device). The actual size is available in `blocksize`. See + * http://www.espruino.com/Performance for more information. * **Note:** To find free areas of flash memory, see `require('Flash').getFree()` * * @param {any} gc - An optional boolean. If `undefined` or `true` Garbage collection is performed, if `false` it is not @@ -7037,13 +7557,13 @@ declare class Modules { * @param {any} id - The module name to remove * @url http://www.espruino.com/Reference#l_Modules_removeCached */ - static removeCached(id: any): any; + static removeCached(id: any): void; /** * Remove all cached modules * @url http://www.espruino.com/Reference#l_Modules_removeAllCached */ - static removeAllCached(): any; + static removeAllCached(): void; /** * Add the given module to the cache @@ -7052,7 +7572,7 @@ declare class Modules { * @param {any} sourcecode - The module's sourcecode * @url http://www.espruino.com/Reference#l_Modules_addCached */ - static addCached(id: any, sourcecode: any): any; + static addCached(id: any, sourcecode: any): void; } @@ -7096,7 +7616,8 @@ interface String { charAt(pos: number): any; /** - * Return the integer value of a single character at the given position in the String. + * Return the integer value of a single character at the given position in the + * String. * Note that this returns 0 not 'NaN' for out of bounds characters * * @param {number} pos - The character number in the string. Negative values return characters from end of string (-1 = last char) @@ -7154,7 +7675,9 @@ interface String { match(substr: any): any; /** - * Search and replace ONE occurrance of `subStr` with `newSubStr` and return the result. This doesn't alter the original string. Regular expressions not supported. + * Search and replace ONE occurrance of `subStr` with `newSubStr` and return the + * result. This doesn't alter the original string. Regular expressions not + * supported. * * @param {any} subStr - The string to search for * @param {any} newSubStr - The string to replace it with @@ -7191,8 +7714,10 @@ interface String { slice(start: number, end: any): any; /** - * Return an array made by splitting this string up by the separator. eg. ```'1,2,3'.split(',')==['1', '2', '3']``` - * Regular Expressions can also be used to split strings, eg. `'1a2b3 4'.split(/[^0-9]/)==['1', '2', '3', '4']`. + * Return an array made by splitting this string up by the separator. eg. + * ```'1,2,3'.split(',')==['1', '2', '3']``` + * Regular Expressions can also be used to split strings, eg. `'1a2b3 + * 4'.split(/[^0-9]/)==['1', '2', '3', '4']`. * * @param {any} separator - The separator `String` or `RegExp` to use * @returns {any} Part of this string from start for len characters @@ -7220,10 +7745,11 @@ interface String { * @returns {any} A String with Whitespace removed from the beginning and end * @url http://www.espruino.com/Reference#l_String_trim */ - trim(): String; + trim(): string; /** - * Append all arguments to this `String` and return the result. Does not modify the original `String`. + * Append all arguments to this `String` and return the result. Does not modify the + * original `String`. * * @param {any} args - Strings to append * @returns {any} The result of appending all arguments to this string @@ -7265,7 +7791,7 @@ interface String { * @returns {any} A string containing repetitions of this string * @url http://www.espruino.com/Reference#l_String_repeat */ - repeat(count: number): String; + repeat(count: number): string; /** * Pad this string at the beginnind to the required number of characters @@ -7279,7 +7805,7 @@ interface String { * @returns {any} A string containing this string padded to the correct length * @url http://www.espruino.com/Reference#l_String_padStart */ - padStart(targetLength: number, padString?: any): String; + padStart(targetLength: number, padString?: any): string; /** * Pad this string at the end to the required number of characters @@ -7293,12 +7819,13 @@ interface String { * @returns {any} A string containing this string padded to the correct length * @url http://www.espruino.com/Reference#l_String_padEnd */ - padEnd(targetLength: number, padString?: any): String; + padEnd(targetLength: number, padString?: any): string; } /** * This is the built-in class for Text Strings. - * Text Strings in Espruino are not zero-terminated, so you can store zeros in them. + * Text Strings in Espruino are not zero-terminated, so you can store zeros in + * them. * @url http://www.espruino.com/Reference#String */ declare const String: StringConstructor @@ -7311,17 +7838,23 @@ interface ArrayConstructor { * @returns {boolean} True if var is an array, false if not. * @url http://www.espruino.com/Reference#l_Array_isArray */ - isArray(variable: any): boolean; + isArray(arg: any): arg is any[]; /** - * Create an Array. Either give it one integer argument (>=0) which is the length of the array, or any number of arguments + * Create an Array. Either give it one integer argument (>=0) which is the length + * of the array, or any number of arguments * @constructor * * @param {any} args - The length of the array OR any number of items to add to the array * @returns {any} An Array * @url http://www.espruino.com/Reference#l_Array_Array */ - new(...args: any[]): any; + new(arrayLength?: number): any[]; + new(arrayLength: number): T[]; + new(...items: T[]): T[]; + (arrayLength?: number): any[]; + (arrayLength: number): T[]; + (...items: T[]): T[]; } interface Array { @@ -7332,14 +7865,14 @@ interface Array { * @returns {any} A String representing the array * @url http://www.espruino.com/Reference#l_Array_toString */ - toString(radix: any): any; + toString(): string; /** * Find the length of the array - * @returns {any} The value of the array + * @returns {any} The length of the array * @url http://www.espruino.com/Reference#l_Array_length */ - length: any; + length: number; /** * Return the index of the value in the array, or -1 @@ -7349,7 +7882,7 @@ interface Array { * @returns {any} the index of the value in the array, or -1 * @url http://www.espruino.com/Reference#l_Array_indexOf */ - indexOf(value: any, startIndex: number): any; + indexOf(value: T, startIndex?: number): number; /** * Return `true` if the array includes the value, `false` otherwise @@ -7359,44 +7892,48 @@ interface Array { * @returns {boolean} `true` if the array includes the value, `false` otherwise * @url http://www.espruino.com/Reference#l_Array_includes */ - includes(value: any, startIndex: number): boolean; + includes(value: T, startIndex?: number): boolean; /** - * Join all elements of this array together into one string, using 'separator' between them. eg. ```[1,2,3].join(' ')=='1 2 3'``` + * Join all elements of this array together into one string, using 'separator' + * between them. e.g. ```[1,2,3].join(' ')=='1 2 3'``` * * @param {any} separator - The separator * @returns {any} A String representing the Joined array * @url http://www.espruino.com/Reference#l_Array_join */ - join(separator: any): any; + join(separator?: string): string; /** * Push a new value onto the end of this array' - * This is the opposite of `[1,2,3].unshift(0)`, which adds one or more elements to the beginning of the array. + * This is the opposite of `[1,2,3].unshift(0)`, which adds one or more elements to + * the beginning of the array. * * @param {any} arguments - One or more arguments to add * @returns {number} The new size of the array * @url http://www.espruino.com/Reference#l_Array_push */ - push(...arguments: any[]): number; + push(...arguments: T[]): number; /** * Remove and return the value on the end of this array. - * This is the opposite of `[1,2,3].shift()`, which removes an element from the beginning of the array. + * This is the opposite of `[1,2,3].shift()`, which removes an element from the + * beginning of the array. * @returns {any} The value that is popped off * @url http://www.espruino.com/Reference#l_Array_pop */ - pop(): any; + pop(): T | undefined; /** - * Return an array which is made from the following: ```A.map(function) = [function(A[0]), function(A[1]), ...]``` + * Return an array which is made from the following: ```A.map(function) = + * [function(A[0]), function(A[1]), ...]``` * * @param {any} function - Function used to map one item to another * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @returns {any} An array containing the results * @url http://www.espruino.com/Reference#l_Array_map */ - map(func: any, thisArg: any): any; + map(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[]; /** * Executes a provided function once per array element. @@ -7405,20 +7942,23 @@ interface Array { * @param {any} [thisArg] - [optional] If specified, the function is called with 'this' set to thisArg (optional) * @url http://www.espruino.com/Reference#l_Array_forEach */ - forEach(callback: (item: T, index: number, array: T[]) => void, thisArg?: any): void; + forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void; /** - * Return an array which contains only those elements for which the callback function returns 'true' + * Return an array which contains only those elements for which the callback + * function returns 'true' * * @param {any} function - Function to be executed * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @returns {any} An array containing the results * @url http://www.espruino.com/Reference#l_Array_filter */ - filter(func: any, thisArg: any): any; + filter(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[]; + filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[]; /** - * Return the array element where `function` returns `true`, or `undefined` if it doesn't returns `true` for any element. + * Return the array element where `function` returns `true`, or `undefined` if it + * doesn't returns `true` for any element. * ``` * ["Hello","There","World"].find(a=>a[0]=="T") * // returns "There" @@ -7428,10 +7968,12 @@ interface Array { * @returns {any} The array element where `function` returns `true`, or `undefined` * @url http://www.espruino.com/Reference#l_Array_find */ - find(func: any): any; + find(predicate: (this: void, value: T, index: number, obj: T[]) => value is S): S | undefined; + find(predicate: (value: T, index: number, obj: T[]) => unknown): T | undefined; /** - * Return the array element's index where `function` returns `true`, or `-1` if it doesn't returns `true` for any element. + * Return the array element's index where `function` returns `true`, or `-1` if it + * doesn't returns `true` for any element. * ``` * ["Hello","There","World"].findIndex(a=>a[0]=="T") * // returns 1 @@ -7441,17 +7983,18 @@ interface Array { * @returns {any} The array element's index where `function` returns `true`, or `-1` * @url http://www.espruino.com/Reference#l_Array_findIndex */ - findIndex(func: any): any; + findIndex(predicate: (value: T, index: number, obj: T[]) => unknown): number; /** - * Return 'true' if the callback returns 'true' for any of the elements in the array + * Return 'true' if the callback returns 'true' for any of the elements in the + * array * * @param {any} function - Function to be executed * @param {any} thisArg - if specified, the function is called with 'this' set to thisArg (optional) * @returns {any} A boolean containing the result * @url http://www.espruino.com/Reference#l_Array_some */ - some(func: any, thisArg: any): any; + some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean; /** * Return 'true' if the callback returns 'true' for every element in the array @@ -7461,17 +8004,19 @@ interface Array { * @returns {any} A boolean containing the result * @url http://www.espruino.com/Reference#l_Array_every */ - every(func: any, thisArg: any): any; + every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean; /** - * Execute `previousValue=initialValue` and then `previousValue = callback(previousValue, currentValue, index, array)` for each element in the array, and finally return previousValue. + * Execute `previousValue=initialValue` and then `previousValue = + * callback(previousValue, currentValue, index, array)` for each element in the + * array, and finally return previousValue. * * @param {any} callback - Function used to reduce the array * @param {any} initialValue - if specified, the initial value to pass to the function * @returns {any} The value returned by the last function called * @url http://www.espruino.com/Reference#l_Array_reduce */ - reduce(callback: any, initialValue: any): any; + reduce(callback: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T; /** * Both remove and add items to an array @@ -7482,7 +8027,7 @@ interface Array { * @returns {any} An array containing the removed elements. If only one element is removed, an array of one element is returned. * @url http://www.espruino.com/Reference#l_Array_splice */ - splice(index: number, howMany: any, ...elements: any[]): any; + splice(index: number, howMany?: number, ...elements: T[]): T[]; /** * Remove and return the first element of the array. @@ -7491,17 +8036,18 @@ interface Array { * @returns {any} The element that was removed * @url http://www.espruino.com/Reference#l_Array_shift */ - shift(): any; + shift(): T | undefined; /** * Add one or more items to the start of the array, and return its new length. - * This is the opposite of `[1,2,3].push(4)`, which puts one or more elements on the end. + * This is the opposite of `[1,2,3].push(4)`, which puts one or more elements on + * the end. * * @param {any} elements - One or more items to add to the beginning of the array * @returns {number} The new array length * @url http://www.espruino.com/Reference#l_Array_unshift */ - unshift(...elements: any[]): number; + unshift(...elements: T[]): number; /** * Return a copy of a portion of this array (in a new array) @@ -7511,7 +8057,7 @@ interface Array { * @returns {any} A new array * @url http://www.espruino.com/Reference#l_Array_slice */ - slice(start: number, end: any): any; + slice(start?: number, end?: number): T[]; /** * Do an in-place quicksort of the array @@ -7520,16 +8066,17 @@ interface Array { * @returns {any} This array object * @url http://www.espruino.com/Reference#l_Array_sort */ - sort(variable: any): any; + sort(compareFn?: (a: T, b: T) => number): T[]; /** - * Create a new array, containing the elements from this one and any arguments, if any argument is an array then those elements will be added. + * Create a new array, containing the elements from this one and any arguments, if + * any argument is an array then those elements will be added. * * @param {any} args - Any items to add to the array * @returns {any} An Array * @url http://www.espruino.com/Reference#l_Array_concat */ - concat(...args: any[]): any; + concat(...args: (T | T[])[]): T[]; /** * Fill this array with the given value, for every index `>= start` and `< end` @@ -7540,19 +8087,22 @@ interface Array { * @returns {any} This array * @url http://www.espruino.com/Reference#l_Array_fill */ - fill(value: any, start: number, end: any): any; + fill(value: T, start: number, end?: number): T[]; /** * Reverse all elements in this array (in place) * @returns {any} The array, but reversed. * @url http://www.espruino.com/Reference#l_Array_reverse */ - reverse(): any; + reverse(): T[]; + + [index: number]: T } /** * This is the built-in JavaScript class for arrays. - * Arrays can be defined with ```[]```, ```new Array()```, or ```new Array(length)``` + * Arrays can be defined with ```[]```, ```new Array()```, or ```new + * Array(length)``` * @url http://www.espruino.com/Reference#Array */ declare const Array: ArrayConstructor @@ -7568,7 +8118,8 @@ interface ObjectConstructor { keys(object: any): any; /** - * Returns an array of all properties (enumerable or not) found directly on a given object. + * Returns an array of all properties (enumerable or not) found directly on a given + * object. * * @param {any} object - The Object to return a list of property names for * @returns {any} An array of the Object's own properties @@ -7595,7 +8146,8 @@ interface ObjectConstructor { entries(object: any): any; /** - * Creates a new object with the specified prototype object and properties. properties are currently unsupported. + * Creates a new object with the specified prototype object and properties. + * properties are currently unsupported. * * @param {any} proto - A prototype object * @param {any} propertiesObject - An object containing properties. NOT IMPLEMENTED @@ -7616,13 +8168,19 @@ interface ObjectConstructor { /** * Add a new property to the Object. 'Desc' is an object with the following fields: - * * `configurable` (bool = false) - can this property be changed/deleted (not implemented) - * * `enumerable` (bool = false) - can this property be enumerated (not implemented) + * * `configurable` (bool = false) - can this property be changed/deleted (not + * implemented) + * * `enumerable` (bool = false) - can this property be enumerated (not + * implemented) * * `value` (anything) - the value of this property - * * `writable` (bool = false) - can the value be changed with the assignment operator? - * * `get` (function) - the getter function, or undefined if no getter (only supported on some platforms) - * * `set` (function) - the setter function, or undefined if no setter (only supported on some platforms) - * **Note:** `configurable`, `enumerable` and `writable` are not implemented and will be ignored. + * * `writable` (bool = false) - can the value be changed with the assignment + * operator? + * * `get` (function) - the getter function, or undefined if no getter (only + * supported on some platforms) + * * `set` (function) - the setter function, or undefined if no setter (only + * supported on some platforms) + * **Note:** `configurable`, `enumerable` and `writable` are not implemented and + * will be ignored. * * @param {any} obj - An object * @param {any} name - The name of the property @@ -7633,7 +8191,8 @@ interface ObjectConstructor { defineProperty(obj: any, name: any, desc: any): any; /** - * Adds new properties to the Object. See `Object.defineProperty` for more information + * Adds new properties to the Object. See `Object.defineProperty` for more + * information * * @param {any} obj - An object * @param {any} props - An object whose fields represent property names, and whose values are property descriptors. @@ -7653,8 +8212,8 @@ interface ObjectConstructor { getPrototypeOf(object: any): any; /** - * Set the prototype of the given object - this is like writing - * `object.__proto__ = prototype` but is the 'proper' ES6 way of doing it + * Set the prototype of the given object - this is like writing `object.__proto__ = + * prototype` but is the 'proper' ES6 way of doing it * * @param {any} object - An object * @param {any} prototype - The prototype to set on the object @@ -7718,7 +8277,8 @@ interface Object { /** * Return true if the object (not its prototype) has the given property. - * NOTE: This currently returns false-positives for built-in functions in prototypes + * NOTE: This currently returns false-positives for built-in functions in + * prototypes * * @param {any} name - The name of the property to search for * @returns {boolean} True if it exists, false if it doesn't @@ -7727,9 +8287,10 @@ interface Object { hasOwnProperty(name: any): boolean; /** - * Register an event listener for this object, for instance `Serial1.on('data', function(d) {...})`. - * This is the same as Node.js's [EventEmitter](https://nodejs.org/api/events.html) but on Espruino - * the functionality is built into every object: + * Register an event listener for this object, for instance `Serial1.on('data', + * function(d) {...})`. + * This is the same as Node.js's [EventEmitter](https://nodejs.org/api/events.html) + * but on Espruino the functionality is built into every object: * * `Object.on` * * `Object.emit` * * `Object.removeListener` @@ -7763,17 +8324,18 @@ interface Object { * @param {any} listener - The listener to call when this event is received * @url http://www.espruino.com/Reference#l_Object_on */ - on(event: any, listener: any): any; + on(event: any, listener: any): void; /** - * Call any event listeners that were added to this object with `Object.on`, for instance `obj.emit('data', 'Foo')`. + * Call any event listeners that were added to this object with `Object.on`, for + * instance `obj.emit('data', 'Foo')`. * For more information see `Object.on` * * @param {any} event - The name of the event, for instance 'data' * @param {any} args - Optional arguments * @url http://www.espruino.com/Reference#l_Object_emit */ - emit(event: any, ...args: any[]): any; + emit(event: any, ...args: any[]): void; /** * Removes the specified event listener. @@ -7790,7 +8352,7 @@ interface Object { * @param {any} listener - The listener to remove * @url http://www.espruino.com/Reference#l_Object_removeListener */ - removeListener(event: any, listener: any): any; + removeListener(event: any, listener: any): void; /** * Removes all listeners (if `event===undefined`), or those of the specified event. @@ -7805,7 +8367,7 @@ interface Object { * @param {any} event - The name of the event, for instance `'data'`. If not specified *all* listeners are removed. * @url http://www.espruino.com/Reference#l_Object_removeAllListeners */ - removeAllListeners(event: any): any; + removeAllListeners(event: any): void; } /** @@ -7828,13 +8390,14 @@ interface FunctionConstructor { interface Function { /** - * This replaces the function with the one in the argument - while keeping the old function's scope. - * This allows inner functions to be edited, and is used when edit() is called on an inner function. + * This replaces the function with the one in the argument - while keeping the old + * function's scope. This allows inner functions to be edited, and is used when + * edit() is called on an inner function. * * @param {any} newFunc - The new function to replace this function with * @url http://www.espruino.com/Reference#l_Function_replaceWith */ - replaceWith(newFunc: any): any; + replaceWith(newFunc: any): void; /** * This executes the function with the supplied 'this' argument and parameters @@ -7879,7 +8442,8 @@ declare const Function: FunctionConstructor */ declare class E { /** - * Setup the filesystem so that subsequent calls to `E.openFile` and `require('fs').*` will use an SD card on the supplied SPI device and pin. + * Setup the filesystem so that subsequent calls to `E.openFile` and + * `require('fs').*` will use an SD card on the supplied SPI device and pin. * It can even work using software SPI - for instance: * ``` * // DI/CMD = C7 @@ -7892,22 +8456,25 @@ declare class E { * console.log(require("fs").readdirSync()); * ``` * See [the page on File IO](http://www.espruino.com/File+IO) for more information. - * **Note:** We'd strongly suggest you add a pullup resistor from CD/CS pin to 3.3v. It is - * good practise to avoid accidental writes before Espruino is initialised, and some cards - * will not work reliably without one. - * **Note:** If you want to remove an SD card after you have started using it, you *must* call `E.unmountSD()` or you may cause damage to the card. + * **Note:** We'd strongly suggest you add a pullup resistor from CD/CS pin to + * 3.3v. It is good practise to avoid accidental writes before Espruino is + * initialised, and some cards will not work reliably without one. + * **Note:** If you want to remove an SD card after you have started using it, you + * *must* call `E.unmountSD()` or you may cause damage to the card. * * @param {any} spi - The SPI object to use for communication * @param {Pin} csPin - The pin to use for Chip Select * @url http://www.espruino.com/Reference#l_E_connectSDCard */ - static connectSDCard(spi: any, csPin: Pin): any; + static connectSDCard(spi: any, csPin: Pin): void; /** - * Unmount the SD card, so it can be removed. If you remove the SD card without calling this you may cause corruption, and you will be unable to access another SD card until you reset Espruino or call `E.unmountSD()`. + * Unmount the SD card, so it can be removed. If you remove the SD card without + * calling this you may cause corruption, and you will be unable to access another + * SD card until you reset Espruino or call `E.unmountSD()`. * @url http://www.espruino.com/Reference#l_E_unmountSD */ - static unmountSD(): any; + static unmountSD(): void; /** * Open a file @@ -7920,8 +8487,8 @@ declare class E { static openFile(path: any, mode: any): File; /** - * Change the parameters used for the flash filesystem. - * The default address is the last 1Mb of 4Mb Flash, 0x300000, with total size of 1Mb. + * Change the parameters used for the flash filesystem. The default address is the + * last 1Mb of 4Mb Flash, 0x300000, with total size of 1Mb. * Before first use the media needs to be formatted. * ``` * fs=require("fs"); @@ -7934,8 +8501,9 @@ declare class E { * fs.writeFileSync("bang.txt", "This is the way the world ends\nnot with a bang but a whimper.\n"); * fs.readdirSync(); * ``` - * This will create a drive of 100 * 4096 bytes at 0x300000. Be careful with the selection of flash addresses as you can overwrite firmware! - * You only need to format once, as each will erase the content. + * This will create a drive of 100 * 4096 bytes at 0x300000. Be careful with the + * selection of flash addresses as you can overwrite firmware! You only need to + * format once, as each will erase the content. * `E.flashFatFS({ addr:0x300000,sectors:100,format:true });` * * @param {any} options @@ -7950,8 +8518,8 @@ declare class E { /** * Display a menu on the screen, and set up the buttons to navigate through it. - * Supply an object containing menu items. When an item is selected, the - * function it references will be executed. For example: + * Supply an object containing menu items. When an item is selected, the function + * it references will be executed. For example: * ``` * var boolean = false; * var number = 50; @@ -7983,8 +8551,8 @@ declare class E { * // Actually display the menu * E.showMenu(mainmenu); * ``` - * The menu will stay onscreen and active until explicitly removed, - * which you can do by calling `E.showMenu()` without arguments. + * The menu will stay onscreen and active until explicitly removed, which you can + * do by calling `E.showMenu()` without arguments. * See http://www.espruino.com/graphical_menu for more detailed information. * * @param {any} menu - An object containing name->function mappings to to be used in a menu @@ -7992,6 +8560,7 @@ declare class E { * @url http://www.espruino.com/Reference#l_E_showMenu */ static showMenu(menu: Menu): MenuInstance; + static showMenu(): void; /** * A utility function for displaying a full screen message on the screen. @@ -8004,14 +8573,13 @@ declare class E { * @param {any} title - (optional) a title for the message * @url http://www.espruino.com/Reference#l_E_showMessage */ - static showMessage(message: any, title: any): any; + static showMessage(message: string, title?: string): void; /** - * Displays a full screen prompt on the screen, with the buttons - * requested (or `Yes` and `No` for defaults). - * When the button is pressed the promise is resolved with the - * requested values (for the `Yes` and `No` defaults, `true` and `false` - * are returned). + * Displays a full screen prompt on the screen, with the buttons requested (or + * `Yes` and `No` for defaults). + * When the button is pressed the promise is resolved with the requested values + * (for the `Yes` and `No` defaults, `true` and `false` are returned). * ``` * E.showPrompt("Do you like fish?").then(function(v) { * if (v) print("'Yes' chosen"); @@ -8039,7 +8607,8 @@ declare class E { * @returns {any} A promise that is resolved when 'Ok' is pressed * @url http://www.espruino.com/Reference#l_E_showPrompt */ - static showPrompt(message: any, options: any): any; + static showPrompt(message: string, options?: { title?: string, buttons?: { [key: string]: T } }): Promise; + static showPrompt(): void; /** * Displays a full screen prompt on the screen, with a single 'Ok' button. @@ -8060,10 +8629,11 @@ declare class E { * @returns {any} A promise that is resolved when 'Ok' is pressed * @url http://www.espruino.com/Reference#l_E_showAlert */ - static showAlert(message: any, options: any): any; + static showAlert(message?: string, options?: string): Promise; /** - * Called when a notification arrives on an Apple iOS device Bangle.js is connected to + * Called when a notification arrives on an Apple iOS device Bangle.js is connected + * to * ``` * { * event:"add", @@ -8089,7 +8659,8 @@ declare class E { static on(event: "ANCS", callback: (info: any) => void): void; /** - * Called when a media event arrives on an Apple iOS device Bangle.js is connected to + * Called when a media event arrives on an Apple iOS device Bangle.js is connected + * to * ``` * { * id : "artist"/"album"/"title"/"duration", @@ -8106,8 +8677,8 @@ declare class E { /** * Display a menu on the screen, and set up the buttons to navigate through it. - * Supply an object containing menu items. When an item is selected, the - * function it references will be executed. For example: + * Supply an object containing menu items. When an item is selected, the function + * it references will be executed. For example: * ``` * var boolean = false; * var number = 50; @@ -8139,20 +8710,25 @@ declare class E { * // Actually display the menu * E.showMenu(mainmenu); * ``` - * The menu will stay onscreen and active until explicitly removed, - * which you can do by calling `E.showMenu()` without arguments. + * The menu will stay onscreen and active until explicitly removed, which you can + * do by calling `E.showMenu()` without arguments. * See http://www.espruino.com/graphical_menu for more detailed information. * On Bangle.js there are a few additions over the standard `graphical_menu`: * * The options object can contain: - * * `back : function() { }` - add a 'back' button, with the function called when it is pressed - * * (Bangle.js 2) `scroll : int` - an integer specifying how much the initial menu should be scrolled by + * * `back : function() { }` - add a 'back' button, with the function called when + * it is pressed + * * (Bangle.js 2) `scroll : int` - an integer specifying how much the initial + * menu should be scrolled by * * The object returned by `E.showMenu` contains: - * * (Bangle.js 2) `scroller` - the object returned by `E.showScroller` - `scroller.scroll` returns the amount the menu is currently scrolled by + * * (Bangle.js 2) `scroller` - the object returned by `E.showScroller` - + * `scroller.scroll` returns the amount the menu is currently scrolled by * * In the object specified for editable numbers: - * * (Bangle.js 2) the `format` function is called with `format(value)` in the main menu, `format(value,1)` when in a scrollable list, or `format(value,2)` when in a popup window. - * You can also specify menu items as an array (rather than an Object). This can be useful - * if you have menu items with the same title, or you want to `push` menu items onto an - * array: + * * (Bangle.js 2) the `format` function is called with `format(value)` in the + * main menu, `format(value,1)` when in a scrollable list, or `format(value,2)` + * when in a popup window. + * You can also specify menu items as an array (rather than an Object). This can be + * useful if you have menu items with the same title, or you want to `push` menu + * items onto an array: * ``` * var menu = [ * { title:"Something", onchange:function() { print("selected"); } }, @@ -8168,6 +8744,7 @@ declare class E { * @url http://www.espruino.com/Reference#l_E_showMenu */ static showMenu(menu: Menu): MenuInstance; + static showMenu(): void; /** * A utility function for displaying a full screen message on the screen. @@ -8187,14 +8764,13 @@ declare class E { * @param {any} options - (optional) a title for the message, or an object of options `{title:string, img:image_string}` * @url http://www.espruino.com/Reference#l_E_showMessage */ - static showMessage(message: any, options: any): any; + static showMessage(message: string, title?: string | { title?: string, img?: string }): void; /** - * Displays a full screen prompt on the screen, with the buttons - * requested (or `Yes` and `No` for defaults). - * When the button is pressed the promise is resolved with the - * requested values (for the `Yes` and `No` defaults, `true` and `false` - * are returned). + * Displays a full screen prompt on the screen, with the buttons requested (or + * `Yes` and `No` for defaults). + * When the button is pressed the promise is resolved with the requested values + * (for the `Yes` and `No` defaults, `true` and `false` are returned). * ``` * E.showPrompt("Do you like fish?").then(function(v) { * if (v) print("'Yes' chosen"); @@ -8230,11 +8806,12 @@ declare class E { * @returns {any} A promise that is resolved when 'Ok' is pressed * @url http://www.espruino.com/Reference#l_E_showPrompt */ - static showPrompt(message: any, options: any): any; + static showPrompt(message: string, options?: { title?: string, buttons?: { [key: string]: T } }): Promise; + static showPrompt(): void; /** - * Display a scrollable menu on the screen, and set up the buttons/touchscreen to navigate through it - * and select items. + * Display a scrollable menu on the screen, and set up the buttons/touchscreen to + * navigate through it and select items. * Supply an object containing: * ``` * { @@ -8265,27 +8842,28 @@ declare class E { * @returns {any} A menu object with `draw()` and `drawItem(itemNo)` functions * @url http://www.espruino.com/Reference#l_E_showScroller */ - static showScroller(options: any): any; + static showScroller(options?: { h: number, c: number, draw: (idx: number, rect: { x: number, y: number, w: number, h: number }) => void, select: (idx: number) => void, back?: () => void }): { draw: () => void, drawItem: (itemNo: number) => void }; + static showScroller(): void; /** * @url http://www.espruino.com/Reference#l_E_showMenu */ - static showMenu(): any; + static showMenu(): void; /** * @url http://www.espruino.com/Reference#l_E_showMenu */ - static showMenu(): any; + static showMenu(): void; /** * @url http://www.espruino.com/Reference#l_E_showPrompt */ - static showPrompt(): any; + static showPrompt(): void; /** * @url http://www.espruino.com/Reference#l_E_showScroller */ - static showScroller(): any; + static showScroller(): void; /** * Displays a full screen prompt on the screen, with a single 'Ok' button. @@ -8306,7 +8884,7 @@ declare class E { * @returns {any} A promise that is resolved when 'Ok' is pressed * @url http://www.espruino.com/Reference#l_E_showAlert */ - static showAlert(message: any, options: any): any; + static showAlert(message?: string, options?: string): Promise; /** * This event is called right after the board starts up, and has a similar effect @@ -8335,9 +8913,9 @@ declare class E { * console.log("Bye!"); * }); * ``` - * **NOTE:** This event is not called when the device is 'hard reset' - for - * example by removing power, hitting an actual reset button, or via - * a Watchdog timer reset. + * **NOTE:** This event is not called when the device is 'hard reset' - for example + * by removing power, hitting an actual reset button, or via a Watchdog timer + * reset. * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_E_kill @@ -8345,26 +8923,25 @@ declare class E { static on(event: "kill", callback: () => void): void; /** - * This event is called when an error is created by Espruino itself (rather - * than JS code) which changes the state of the error flags reported by - * `E.getErrorFlags()` + * This event is called when an error is created by Espruino itself (rather than JS + * code) which changes the state of the error flags reported by `E.getErrorFlags()` * This could be low memory, full buffers, UART overflow, etc. `E.getErrorFlags()` * has a full description of each type of error. - * This event will only be emitted when error flag is set. If the error - * flag was already set nothing will be emitted. To clear error flags - * so that you do get a callback each time a flag is set, call `E.getErrorFlags()`. + * This event will only be emitted when error flag is set. If the error flag was + * already set nothing will be emitted. To clear error flags so that you do get a + * callback each time a flag is set, call `E.getErrorFlags()`. * @param {string} event - The event to listen to. * @param {(errorFlags: any) => void} callback - A function that is executed when the event occurs. Its arguments are: * * `errorFlags` An array of new error flags, as would be returned by `E.getErrorFlags()`. Error flags that were present before won't be reported. * @url http://www.espruino.com/Reference#l_E_errorFlag */ - static on(event: "errorFlag", callback: (errorFlags: any) => void): void; + static on(event: "errorFlag", callback: (errorFlags: ErrorFlag[]) => void): void; /** - * This event is called when a full touchscreen device on an Espruino - * is interacted with. - * **Note:** This event is not implemented on Bangle.js because - * it only has a two area touchscreen. + * This event is called when a full touchscreen device on an Espruino is interacted + * with. + * **Note:** This event is not implemented on Bangle.js because it only has a two + * area touchscreen. * To use the touchscreen to draw lines, you could do: * ``` * var last; @@ -8385,31 +8962,44 @@ declare class E { /** * Use the microcontroller's internal thermistor to work out the temperature. - * On Puck.js v2.0 this will use the on-board PCT2075TP temperature sensor, but on other devices it may not be desperately well calibrated. - * While this is implemented on Espruino boards, it may not be implemented on other devices. If so it'll return NaN. - * **Note:** This is not entirely accurate and varies by a few degrees from chip to chip. It measures the **die temperature**, so when connected to USB it could be reading 10 over degrees C above ambient temperature. When running from battery with `setDeepSleep(true)` it is much more accurate though. + * On Puck.js v2.0 this will use the on-board PCT2075TP temperature sensor, but on + * other devices it may not be desperately well calibrated. + * While this is implemented on Espruino boards, it may not be implemented on other + * devices. If so it'll return NaN. + * **Note:** This is not entirely accurate and varies by a few degrees from chip + * to chip. It measures the **die temperature**, so when connected to USB it could + * be reading 10 over degrees C above ambient temperature. When running from + * battery with `setDeepSleep(true)` it is much more accurate though. * @returns {number} The temperature in degrees C * @url http://www.espruino.com/Reference#l_E_getTemperature */ static getTemperature(): number; /** - * Check the internal voltage reference. To work out an actual voltage of an input pin, you can use `analogRead(pin)*E.getAnalogVRef()` - * **Note:** This value is calculated by reading the voltage on an internal voltage reference with the ADC. - * It will be slightly noisy, so if you need this for accurate measurements we'd recommend that you call - * this function several times and average the results. - * While this is implemented on Espruino boards, it may not be implemented on other devices. If so it'll return NaN. + * Check the internal voltage reference. To work out an actual voltage of an input + * pin, you can use `analogRead(pin)*E.getAnalogVRef()` + * **Note:** This value is calculated by reading the voltage on an internal + * voltage reference with the ADC. It will be slightly noisy, so if you need this + * for accurate measurements we'd recommend that you call this function several + * times and average the results. + * While this is implemented on Espruino boards, it may not be implemented on other + * devices. If so it'll return NaN. * @returns {number} The voltage (in Volts) that a reading of 1 from `analogRead` actually represents - usually around 3.3v * @url http://www.espruino.com/Reference#l_E_getAnalogVRef */ static getAnalogVRef(): number; /** - * ADVANCED: This is a great way to crash Espruino if you're not sure what you are doing - * Create a native function that executes the code at the given address. Eg. `E.nativeCall(0x08012345,'double (double,double)')(1.1, 2.2)` - * If you're executing a thumb function, you'll almost certainly need to set the bottom bit of the address to 1. - * Note it's not guaranteed that the call signature you provide can be used - there are limits on the number of arguments allowed. - * When supplying `data`, if it is a 'flat string' then it will be used directly, otherwise it'll be converted to a flat string and used. + * ADVANCED: This is a great way to crash Espruino if you're not sure what you are + * doing + * Create a native function that executes the code at the given address, e.g. + * `E.nativeCall(0x08012345,'double (double,double)')(1.1, 2.2)` + * If you're executing a thumb function, you'll almost certainly need to set the + * bottom bit of the address to 1. + * Note it's not guaranteed that the call signature you provide can be used - there + * are limits on the number of arguments allowed. + * When supplying `data`, if it is a 'flat string' then it will be used directly, + * otherwise it'll be converted to a flat string and used. * * @param {number} addr - The address in memory of the function (or offset in `data` if it was supplied * @param {any} sig - The signature of the call, `returnType (arg1,arg2,...)`. Allowed types are `void`,`bool`,`int`,`double`,`Pin`,`JsVar` @@ -8417,7 +9007,7 @@ declare class E { * @returns {any} The native function * @url http://www.espruino.com/Reference#l_E_nativeCall */ - static nativeCall(addr: number, sig: any, data: any): any; + static nativeCall(addr: number, sig: string, data?: string): any; /** * Clip a number to be between min and max (inclusive) @@ -8437,20 +9027,23 @@ declare class E { * @returns {number} The sum of the given buffer * @url http://www.espruino.com/Reference#l_E_sum */ - static sum(arr: any): number; + static sum(arr: string | number[] | ArrayBuffer): number; /** - * Work out the variance of the contents of the given Array, String or ArrayBuffer and return the result. This is equivalent to `v=0;for (i in arr) v+=Math.pow(mean-arr[i],2)` + * Work out the variance of the contents of the given Array, String or ArrayBuffer + * and return the result. This is equivalent to `v=0;for (i in arr) + * v+=Math.pow(mean-arr[i],2)` * * @param {any} arr - The array to work out the variance for * @param {number} mean - The mean value of the array * @returns {number} The variance of the given buffer * @url http://www.espruino.com/Reference#l_E_variance */ - static variance(arr: any, mean: number): number; + static variance(arr: string | number[] | ArrayBuffer, mean: number): number; /** - * Convolve arr1 with arr2. This is equivalent to `v=0;for (i in arr1) v+=arr1[i] * arr2[(i+offset) % arr2.length]` + * Convolve arr1 with arr2. This is equivalent to `v=0;for (i in arr1) v+=arr1[i] * + * arr2[(i+offset) % arr2.length]` * * @param {any} arr1 - An array to convolve * @param {any} arr2 - An array to convolve @@ -8458,28 +9051,32 @@ declare class E { * @returns {number} The variance of the given buffer * @url http://www.espruino.com/Reference#l_E_convolve */ - static convolve(arr1: any, arr2: any, offset: number): number; + static convolve(arr1: string | number[] | ArrayBuffer, arr2: string | number[] | ArrayBuffer, offset: number): number; /** - * Performs a Fast Fourier Transform (FFT) in 32 bit floats on the supplied data and writes it back into the - * original arrays. Note that if only one array is supplied, the data written back is the modulus of the complex - * result `sqrt(r*r+i*i)`. - * In order to perform the FFT, there has to be enough room on the stack to allocate two arrays of 32 bit - * floating point numbers - this will limit the maximum size of FFT possible to around 1024 items on - * most platforms. - * **Note:** on the Original Espruino board, FFTs are performed in 64bit arithmetic as there isn't - * space to include the 32 bit maths routines (2x more RAM is required). + * Performs a Fast Fourier Transform (FFT) in 32 bit floats on the supplied data + * and writes it back into the original arrays. Note that if only one array is + * supplied, the data written back is the modulus of the complex result + * `sqrt(r*r+i*i)`. + * In order to perform the FFT, there has to be enough room on the stack to + * allocate two arrays of 32 bit floating point numbers - this will limit the + * maximum size of FFT possible to around 1024 items on most platforms. + * **Note:** on the Original Espruino board, FFTs are performed in 64bit arithmetic + * as there isn't space to include the 32 bit maths routines (2x more RAM is + * required). * * @param {any} arrReal - An array of real values * @param {any} arrImage - An array of imaginary values (or if undefined, all values will be taken to be 0) * @param {boolean} inverse - Set this to true if you want an inverse FFT - otherwise leave as 0 * @url http://www.espruino.com/Reference#l_E_FFT */ - static FFT(arrReal: any, arrImage: any, inverse: boolean): any; + static FFT(arrReal: string | number[] | ArrayBuffer, arrImage?: string | number[] | ArrayBuffer, inverse?: boolean): any; /** - * Enable the watchdog timer. This will reset Espruino if it isn't able to return to the idle loop within the timeout. - * If `isAuto` is false, you must call `E.kickWatchdog()` yourself every so often or the chip will reset. + * Enable the watchdog timer. This will reset Espruino if it isn't able to return + * to the idle loop within the timeout. + * If `isAuto` is false, you must call `E.kickWatchdog()` yourself every so often + * or the chip will reset. * ``` * E.enableWatchdog(0.5); // automatic mode * while(1); // Espruino will reboot because it has not been idle for 0.5 sec @@ -8493,57 +9090,73 @@ declare class E { * // Espruino will now reset if everything_ok is false, * // or if the interval fails to be called * ``` - * **NOTE:** This is only implemented on STM32 and nRF5x devices (all official Espruino boards). + * **NOTE:** This is only implemented on STM32 and nRF5x devices (all official + * Espruino boards). * **NOTE:** On STM32 (Pico, WiFi, Original) with `setDeepSleep(1)` you need to - * explicitly wake Espruino up with an interval of less than the watchdog timeout or the watchdog will fire and - * the board will reboot. You can do this with `setInterval("", time_in_milliseconds)`. + * explicitly wake Espruino up with an interval of less than the watchdog timeout + * or the watchdog will fire and the board will reboot. You can do this with + * `setInterval("", time_in_milliseconds)`. * * @param {number} timeout - The timeout in seconds before a watchdog reset * @param {any} isAuto - If undefined or true, the watchdog is kicked automatically. If not, you must call `E.kickWatchdog()` yourself * @url http://www.espruino.com/Reference#l_E_enableWatchdog */ - static enableWatchdog(timeout: number, isAuto: any): any; + static enableWatchdog(timeout: number, isAuto?: boolean): void; /** * Kicks a Watchdog timer set up with `E.enableWatchdog(..., false)`. See * `E.enableWatchdog` for more information. - * **NOTE:** This is only implemented on STM32 and nRF5x devices (all official Espruino boards). + * **NOTE:** This is only implemented on STM32 and nRF5x devices (all official + * Espruino boards). * @url http://www.espruino.com/Reference#l_E_kickWatchdog */ - static kickWatchdog(): any; + static kickWatchdog(): void; /** * Get and reset the error flags. Returns an array that can contain: - * `'FIFO_FULL'`: The receive FIFO filled up and data was lost. This could be state transitions for setWatch, or received characters. - * `'BUFFER_FULL'`: A buffer for a stream filled up and characters were lost. This can happen to any stream - Serial,HTTP,etc. - * `'CALLBACK'`: A callback (`setWatch`, `setInterval`, `on('data',...)`) caused an error and so was removed. - * `'LOW_MEMORY'`: Memory is running low - Espruino had to run a garbage collection pass or remove some of the command history - * `'MEMORY'`: Espruino ran out of memory and was unable to allocate some data that it needed. - * `'UART_OVERFLOW'` : A UART received data but it was not read in time and was lost + * `'FIFO_FULL'`: The receive FIFO filled up and data was lost. This could be state + * transitions for setWatch, or received characters. + * `'BUFFER_FULL'`: A buffer for a stream filled up and characters were lost. This + * can happen to any stream - Serial,HTTP,etc. + * `'CALLBACK'`: A callback (`setWatch`, `setInterval`, `on('data',...)`) caused an + * error and so was removed. + * `'LOW_MEMORY'`: Memory is running low - Espruino had to run a garbage collection + * pass or remove some of the command history + * `'MEMORY'`: Espruino ran out of memory and was unable to allocate some data that + * it needed. + * `'UART_OVERFLOW'` : A UART received data but it was not read in time and was + * lost * @returns {any} An array of error flags * @url http://www.espruino.com/Reference#l_E_getErrorFlags */ - static getErrorFlags(): any; + static getErrorFlags(): ErrorFlag[] /** - * Get Espruino's interpreter flags that control the way it handles your JavaScript code. + * Get Espruino's interpreter flags that control the way it handles your JavaScript + * code. * * `deepSleep` - Allow deep sleep modes (also set by setDeepSleep) - * * `pretokenise` - When adding functions, pre-minify them and tokenise reserved words - * * `unsafeFlash` - Some platforms stop writes/erases to interpreter memory to stop you bricking the device accidentally - this removes that protection - * * `unsyncFiles` - When writing files, *don't* flush all data to the SD card after each command (the default is *to* flush). This is much faster, but can cause filesystem damage if power is lost without the filesystem unmounted. + * * `pretokenise` - When adding functions, pre-minify them and tokenise reserved + * words + * * `unsafeFlash` - Some platforms stop writes/erases to interpreter memory to + * stop you bricking the device accidentally - this removes that protection + * * `unsyncFiles` - When writing files, *don't* flush all data to the SD card + * after each command (the default is *to* flush). This is much faster, but can + * cause filesystem damage if power is lost without the filesystem unmounted. * @returns {any} An object containing flag names and their values * @url http://www.espruino.com/Reference#l_E_getFlags */ - static getFlags(): any; + static getFlags(): { [key in Flag]: boolean } /** - * Set the Espruino interpreter flags that control the way it handles your JavaScript code. - * Run `E.getFlags()` and check its description for a list of available flags and their values. + * Set the Espruino interpreter flags that control the way it handles your + * JavaScript code. + * Run `E.getFlags()` and check its description for a list of available flags and + * their values. * * @param {any} flags - An object containing flag names and boolean values. You need only specify the flags that you want to change. * @url http://www.espruino.com/Reference#l_E_setFlags */ - static setFlags(flags: any): any; + static setFlags(flags: { [key in Flag]?: boolean }): void /** * @@ -8556,44 +9169,50 @@ declare class E { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_E_pipe */ - static pipe(source: any, destination: any, options: any): any; + static pipe(source: any, destination: any, options?: { chunkSize?: number, end?: boolean, complete?: () => void }): void /** - * Create an ArrayBuffer from the given string. This is done via a reference, not a copy - so it is very fast and memory efficient. - * Note that this is an ArrayBuffer, not a Uint8Array. To get one of those, do: `new Uint8Array(E.toArrayBuffer('....'))`. + * Create an ArrayBuffer from the given string. This is done via a reference, not a + * copy - so it is very fast and memory efficient. + * Note that this is an ArrayBuffer, not a Uint8Array. To get one of those, do: + * `new Uint8Array(E.toArrayBuffer('....'))`. * * @param {any} str - The string to convert to an ArrayBuffer * @returns {any} An ArrayBuffer that uses the given string * @url http://www.espruino.com/Reference#l_E_toArrayBuffer */ - static toArrayBuffer(str: any): ArrayBufferView; + static toArrayBuffer(str: string): ArrayBuffer; /** - * Returns a 'flat' string representing the data in the arguments, or return `undefined` - * if a flat string cannot be created. - * This creates a string from the given arguments. If an argument is a String or an Array, - * each element is traversed and added as an 8 bit character. If it is anything else, it is - * converted to a character directly. + * Returns a 'flat' string representing the data in the arguments, or return + * `undefined` if a flat string cannot be created. + * This creates a string from the given arguments. If an argument is a String or an + * Array, each element is traversed and added as an 8 bit character. If it is + * anything else, it is converted to a character directly. * In the case where there's one argument which is an 8 bit typed array backed by a - * flat string of the same length, the backing string will be returned without doing - * a copy or other allocation. The same applies if there's a single argument which - * is itself a flat string. + * flat string of the same length, the backing string will be returned without + * doing a copy or other allocation. The same applies if there's a single argument + * which is itself a flat string. * * @param {any} args - The arguments to convert to a String * @returns {any} A String (or `undefined` if a Flat String cannot be created) * @url http://www.espruino.com/Reference#l_E_toString */ - static toString(...args: any[]): String; + static toString(...args: any[]): string | undefined; /** - * This creates a Uint8Array from the given arguments. These are handled as follows: + * This creates a Uint8Array from the given arguments. These are handled as + * follows: * * `Number` -> read as an integer, using the lowest 8 bits - * * `String` -> use each character's numeric value (eg. `String.charCodeAt(...)`) + * * `String` -> use each character's numeric value (e.g. + * `String.charCodeAt(...)`) * * `Array` -> Call itself on each element * * `ArrayBuffer` or Typed Array -> use the lowest 8 bits of each element * * `Object`: - * * `{data:..., count: int}` -> call itself `object.count` times, on `object.data` - * * `{callback : function}` -> call the given function, call itself on return value + * * `{data:..., count: int}` -> call itself `object.count` times, on + * `object.data` + * * `{callback : function}` -> call the given function, call itself on return + * value * For example: * ``` * E.toUint8Array([1,2,3]) @@ -8610,54 +9229,53 @@ declare class E { * @returns {any} A Uint8Array * @url http://www.espruino.com/Reference#l_E_toUint8Array */ - static toUint8Array(...args: any[]): Uint8Array; + static toUint8Array(...args: Uint8ArrayResolvable[]): Uint8Array; /** - * This performs the same basic function as `JSON.stringify`, - * however `JSON.stringify` adds extra characters to conform - * to the JSON spec which aren't required if outputting JS. - * `E.toJS` will also stringify JS functions, whereas - * `JSON.stringify` ignores them. + * This performs the same basic function as `JSON.stringify`, however + * `JSON.stringify` adds extra characters to conform to the JSON spec which aren't + * required if outputting JS. + * `E.toJS` will also stringify JS functions, whereas `JSON.stringify` ignores + * them. * For example: * * `JSON.stringify({a:1,b:2}) == '{"a":1,"b":2}'` * * `E.toJS({a:1,b:2}) == '{a:1,b:2}'` - * **Note:** Strings generated with `E.toJS` can't be - * reliably parsed by `JSON.parse` - however they are - * valid JS so will work with `eval` (but this has security - * implications if you don't trust the source of the string). - * On the desktop [JSON5 parsers](https://github.com/json5/json5) - * will parse the strings produced by `E.toJS` without trouble. + * **Note:** Strings generated with `E.toJS` can't be reliably parsed by + * `JSON.parse` - however they are valid JS so will work with `eval` (but this has + * security implications if you don't trust the source of the string). + * On the desktop [JSON5 parsers](https://github.com/json5/json5) will parse the + * strings produced by `E.toJS` without trouble. * * @param {any} arg - The JS variable to convert to a string * @returns {any} A String * @url http://www.espruino.com/Reference#l_E_toJS */ - static toJS(arg: any): String; + static toJS(arg: any): string; /** - * This creates and returns a special type of string, which actually references - * a specific memory address. It can be used in order to use sections of - * Flash memory directly in Espruino (for example to execute code straight - * from flash memory with `eval(E.memoryArea( ... ))`) - * **Note:** This is only tested on STM32-based platforms (Espruino Original - * and Espruino Pico) at the moment. + * This creates and returns a special type of string, which actually references a + * specific memory address. It can be used in order to use sections of Flash memory + * directly in Espruino (for example to execute code straight from flash memory + * with `eval(E.memoryArea( ... ))`) + * **Note:** This is only tested on STM32-based platforms (Espruino Original and + * Espruino Pico) at the moment. * * @param {number} addr - The address of the memory area * @param {number} len - The length (in bytes) of the memory area * @returns {any} A String * @url http://www.espruino.com/Reference#l_E_memoryArea */ - static memoryArea(addr: number, len: number): String; + static memoryArea(addr: number, len: number): string; /** * This writes JavaScript code into Espruino's flash memory, to be executed on - * startup. It differs from `save()` in that `save()` saves the whole state of - * the interpreter, whereas this just saves JS code that is executed at boot. + * startup. It differs from `save()` in that `save()` saves the whole state of the + * interpreter, whereas this just saves JS code that is executed at boot. * Code will be executed before `onInit()` and `E.on('init', ...)`. * If `alwaysExec` is `true`, the code will be executed even after a call to - * `reset()`. This is useful if you're making something that you want to - * program, but you want some code that is always built in (for instance - * setting up a display or keyboard). + * `reset()`. This is useful if you're making something that you want to program, + * but you want some code that is always built in (for instance setting up a + * display or keyboard). * To remove boot code that has been saved previously, use `E.setBootCode("")` * **Note:** this removes any code that was previously saved with `save()` * @@ -8665,11 +9283,11 @@ declare class E { * @param {boolean} alwaysExec - Whether to always execute the code (even after a reset) * @url http://www.espruino.com/Reference#l_E_setBootCode */ - static setBootCode(code: any, alwaysExec: boolean): any; + static setBootCode(code: string, alwaysExec?: boolean): void; /** - * This sets the clock frequency of Espruino's processor. It will return `0` if - * it is unimplemented or the clock speed cannot be changed. + * This sets the clock frequency of Espruino's processor. It will return `0` if it + * is unimplemented or the clock speed cannot be changed. * **Note:** On pretty much all boards, UART, SPI, I2C, PWM, etc will change * frequency and will need setting up again in order to work. * ### STM32F4 @@ -8681,13 +9299,13 @@ declare class E { * * `latency` - flash latency from 0..15 * * `PCLK1` - Peripheral clock 1 divisor (default: 2) * * `PCLK2` - Peripheral clock 2 divisor (default: 4) - * The Pico's default is `{M:8, N:336, P:4, Q:7, PCLK1:2, PCLK2:4}`, use - * `{M:8, N:336, P:8, Q:7, PCLK:1, PCLK2:2}` to halve the system clock speed - * while keeping the peripherals running at the same speed (omitting PCLK1/2 - * will lead to the peripherals changing speed too). - * On STM32F4 boards (eg. Espruino Pico), the USB clock needs to be kept at 48Mhz - * or USB will fail to work. You'll also experience USB instability if the processor - * clock falls much below 48Mhz. + * The Pico's default is `{M:8, N:336, P:4, Q:7, PCLK1:2, PCLK2:4}`, use `{M:8, + * N:336, P:8, Q:7, PCLK:1, PCLK2:2}` to halve the system clock speed while keeping + * the peripherals running at the same speed (omitting PCLK1/2 will lead to the + * peripherals changing speed too). + * On STM32F4 boards (e.g. Espruino Pico), the USB clock needs to be kept at 48Mhz + * or USB will fail to work. You'll also experience USB instability if the + * processor clock falls much below 48Mhz. * ### ESP8266 * Just specify an integer value, either 80 or 160 (for 80 or 160Mhz) * @@ -8695,24 +9313,23 @@ declare class E { * @returns {number} The actual frequency the clock has been set to * @url http://www.espruino.com/Reference#l_E_setClock */ - static setClock(options: any): number; + static setClock(options: number | { M: number, N: number, P: number, Q: number, latency?: number, PCLK?: number, PCLK2?: number }): number; /** - * Changes the device that the JS console (otherwise known as the REPL) - * is attached to. If the console is on a device, that - * device can be used for programming Espruino. + * Changes the device that the JS console (otherwise known as the REPL) is attached + * to. If the console is on a device, that device can be used for programming + * Espruino. * Rather than calling `Serial.setConsole` you can call * `E.setConsole("DeviceName")`. - * This is particularly useful if you just want to - * remove the console. `E.setConsole(null)` will - * make the console completely inaccessible. - * `device` may be `"Serial1"`,`"USB"`,`"Bluetooth"`,`"Telnet"`,`"Terminal"`, - * any other *hardware* `Serial` device, or `null` to disable the console completely. + * This is particularly useful if you just want to remove the console. + * `E.setConsole(null)` will make the console completely inaccessible. + * `device` may be `"Serial1"`,`"USB"`,`"Bluetooth"`,`"Telnet"`,`"Terminal"`, any + * other *hardware* `Serial` device, or `null` to disable the console completely. * `options` is of the form: * ``` * { * force : bool // default false, force the console onto this device so it does not move - * // if false, changes in connection state (eg USB/Bluetooth) can move + * // if false, changes in connection state (e.g. USB/Bluetooth) can move * // the console automatically. * } * ``` @@ -8721,19 +9338,20 @@ declare class E { * @param {any} options - (optional) object of options, see below * @url http://www.espruino.com/Reference#l_E_setConsole */ - static setConsole(device: any, options: any): any; + static setConsole(device: "Serial1" | "USB" | "Bluetooth" | "Telnet" | "Terminal" | Serial | null, options?: { force?: boolean }): void; /** * Returns the current console device - see `E.setConsole` for more information. * @returns {any} The current console device as a string, or just `null` if the console is null * @url http://www.espruino.com/Reference#l_E_getConsole */ - static getConsole(): any; + static getConsole(): string | null /** * Reverse the 8 bits in a byte, swapping MSB and LSB. * For example, `E.reverseByte(0b10010000) == 0b00001001`. - * Note that you can reverse all the bytes in an array with: `arr = arr.map(E.reverseByte)` + * Note that you can reverse all the bytes in an array with: `arr = + * arr.map(E.reverseByte)` * * @param {number} x - A byte value to reverse the bits of * @returns {number} The byte with reversed bits @@ -8745,51 +9363,52 @@ declare class E { * Output the current list of Utility Timer Tasks - for debugging only * @url http://www.espruino.com/Reference#l_E_dumpTimers */ - static dumpTimers(): any; + static dumpTimers(): void; /** - * Dump any locked variables that aren't referenced from `global` - for debugging memory leaks only. + * Dump any locked variables that aren't referenced from `global` - for debugging + * memory leaks only. * @url http://www.espruino.com/Reference#l_E_dumpLockedVars */ - static dumpLockedVars(): any; + static dumpLockedVars(): void; /** - * Dump any locked variables that aren't referenced from `global` - for debugging memory leaks only. + * Dump any locked variables that aren't referenced from `global` - for debugging + * memory leaks only. * @url http://www.espruino.com/Reference#l_E_dumpFreeList */ - static dumpFreeList(): any; + static dumpFreeList(): void; /** * Show fragmentation. * * ` ` is free space * * `#` is a normal variable - * * `L` is a locked variable (address used, cannopt be moved) + * * `L` is a locked variable (address used, cannot be moved) * * `=` represents data in a Flat String (must be contiguous) * @url http://www.espruino.com/Reference#l_E_dumpFragmentation */ - static dumpFragmentation(): any; + static dumpFragmentation(): void; /** - * Dumps a comma-separated list of all allocated variables - * along with the variables they link to. Can be used - * to visualise where memory is used. + * Dumps a comma-separated list of all allocated variables along with the variables + * they link to. Can be used to visualise where memory is used. * @url http://www.espruino.com/Reference#l_E_dumpVariables */ - static dumpVariables(): any; + static dumpVariables(): void; /** * BETA: defragment memory! * @url http://www.espruino.com/Reference#l_E_defrag */ - static defrag(): any; + static defrag(): void; /** * Return the number of variable blocks used by the supplied variable. This is - * useful if you're running out of memory and you want to be able to see what - * is taking up most of the available space. - * If `depth>0` and the variable can be recursed into, an array listing all property - * names (including internal Espruino names) and their sizes is returned. If - * `depth>1` there is also a `more` field that inspects the objects's children's + * useful if you're running out of memory and you want to be able to see what is + * taking up most of the available space. + * If `depth>0` and the variable can be recursed into, an array listing all + * property names (including internal Espruino names) and their sizes is returned. + * If `depth>1` there is also a `more` field that inspects the objects' children's * children. * For instance `E.getSizeOf(function(a,b) { })` returns `5`. * But `E.getSizeOf(function(a,b) { }, 1)` returns: @@ -8806,8 +9425,8 @@ declare class E { * "size": 2 } * ] * ``` - * In this case setting depth to `2` will make no difference as there are - * no more children to traverse. + * In this case setting depth to `2` will make no difference as there are no more + * children to traverse. * See http://www.espruino.com/Internals for more information * * @param {any} v - A variable to get the size of @@ -8815,15 +9434,15 @@ declare class E { * @returns {any} Information about the variable size - see below * @url http://www.espruino.com/Reference#l_E_getSizeOf */ - static getSizeOf(v: any, depth: number): any; + static getSizeOf(v: any, depth?: 0): number; + static getSizeOf(v: any, depth: number): VariableSizeInformation; /** - * Return the address in memory of the given variable. This can then - * be used with `peek` and `poke` functions. However, changing data in - * JS variables directly (flatAddress=false) will most likely result in a crash. - * This functions exists to allow embedded targets to set up - * peripherals such as DMA so that they write directly to - * JS variables. + * Return the address in memory of the given variable. This can then be used with + * `peek` and `poke` functions. However, changing data in JS variables directly + * (flatAddress=false) will most likely result in a crash. + * This functions exists to allow embedded targets to set up peripherals such as + * DMA so that they write directly to JS variables. * See http://www.espruino.com/Internals for more information * * @param {any} v - A variable to get the address of @@ -8834,8 +9453,8 @@ declare class E { static getAddressOf(v: any, flatAddress: boolean): number; /** - * Take each element of the `from` array, look it up in `map` (or call `map(value,index)` - * if it is a function), and write it into the corresponding + * Take each element of the `from` array, look it up in `map` (or call + * `map(value,index)` if it is a function), and write it into the corresponding * element in the `to` array. * You can use an array to map: * ``` @@ -8871,7 +9490,7 @@ declare class E { * @param {number} bits - If specified, the number of bits per element (MSB first) - otherwise use a 1:1 mapping. If negative, use LSB first. * @url http://www.espruino.com/Reference#l_E_mapInPlace */ - static mapInPlace(from: any, to: any, map: any, bits: number): any; + static mapInPlace(from: ArrayBuffer, to: ArrayBuffer, map?: number[] | ((value: number, index: number) => number) | undefined, bits?: number): void; /** * Search in an Object, Array, or Function @@ -8882,14 +9501,16 @@ declare class E { * @returns {any} The value in the Object matching 'needle', or if `returnKey==true` the key's name - or undefined * @url http://www.espruino.com/Reference#l_E_lookupNoCase */ - static lookupNoCase(haystack: any, needle: any, returnKey: boolean): any; + static lookupNoCase(haystack: any[] | object | Function, needle: string, returnKey?: false): any; + static lookupNoCase(haystack: any[] | object | Function, needle: T, returnKey: true): T | undefined; /** - * Get the current interpreter state in a text form such that it can be copied to a new device + * Get the current interpreter state in a text form such that it can be copied to a + * new device * @returns {any} A String * @url http://www.espruino.com/Reference#l_E_dumpStr */ - static dumpStr(): String; + static dumpStr(): string; /** * Set the seed for the random number generator used by `Math.random()`. @@ -8897,21 +9518,20 @@ declare class E { * @param {number} v - The 32 bit integer seed to use for the random number generator * @url http://www.espruino.com/Reference#l_E_srand */ - static srand(v: number): any; + static srand(v: number): void; /** - * Unlike 'Math.random()' which uses a pseudo-random number generator, this - * method reads from the internal voltage reference several times, xoring and - * rotating to try and make a relatively random value from the noise in the - * signal. + * Unlike 'Math.random()' which uses a pseudo-random number generator, this method + * reads from the internal voltage reference several times, XOR-ing and rotating to + * try and make a relatively random value from the noise in the signal. * @returns {number} A random number * @url http://www.espruino.com/Reference#l_E_hwRand */ static hwRand(): number; /** - * Perform a standard 32 bit CRC (Cyclic redundancy check) on the supplied data (one byte at a time) - * and return the result as an unsigned integer. + * Perform a standard 32 bit CRC (Cyclic redundancy check) on the supplied data + * (one byte at a time) and return the result as an unsigned integer. * * @param {any} data - Iterable data to perform CRC32 on (each element treated as a byte) * @returns {any} The CRC of the supplied data @@ -8920,11 +9540,13 @@ declare class E { static CRC32(data: any): any; /** - * Convert hue, saturation and brightness to red, green and blue (packed into an integer if `asArray==false` or an array if `asArray==true`). - * This replaces `Graphics.setColorHSB` and `Graphics.setBgColorHSB`. On devices with 24 bit colour it can - * be used as: `Graphics.setColor(E.HSBtoRGB(h, s, b))` - * You can quickly set RGB items in an Array or Typed Array using `array.set(E.HSBtoRGB(h, s, b,true), offset)`, - * which can be useful with arrays used with `require("neopixel").write`. + * Convert hue, saturation and brightness to red, green and blue (packed into an + * integer if `asArray==false` or an array if `asArray==true`). + * This replaces `Graphics.setColorHSB` and `Graphics.setBgColorHSB`. On devices + * with 24 bit colour it can be used as: `Graphics.setColor(E.HSBtoRGB(h, s, b))` + * You can quickly set RGB items in an Array or Typed Array using + * `array.set(E.HSBtoRGB(h, s, b,true), offset)`, which can be useful with arrays + * used with `require("neopixel").write`. * * @param {number} hue - The hue, as a value between 0 and 1 * @param {number} sat - The saturation, as a value between 0 and 1 @@ -8933,76 +9555,95 @@ declare class E { * @returns {any} A 24 bit number containing bytes representing red, green, and blue `0xBBGGRR`. Or if `asArray` is true, an array `[R,G,B]` * @url http://www.espruino.com/Reference#l_E_HSBtoRGB */ - static HSBtoRGB(hue: number, sat: number, bri: number, asArray: boolean): any; + static HSBtoRGB(hue: number, sat: number, bri: number, asArray?: false): number; + static HSBtoRGB(hue: number, sat: number, bri: number, asArray: true): [number, number, number]; /** - * Set a password on the console (REPL). When powered on, Espruino will - * then demand a password before the console can be used. If you want to - * lock the console immediately after this you can call `E.lockConsole()` + * Set a password on the console (REPL). When powered on, Espruino will then demand + * a password before the console can be used. If you want to lock the console + * immediately after this you can call `E.lockConsole()` * To remove the password, call this function with no arguments. * **Note:** There is no protection against multiple password attempts, so someone * could conceivably try every password in a dictionary. - * **Note:** This password is stored in memory in plain text. If someone is able - * to execute arbitrary JavaScript code on the device (eg, you use `eval` on input + * **Note:** This password is stored in memory in plain text. If someone is able to + * execute arbitrary JavaScript code on the device (e.g., you use `eval` on input * from unknown sources) or read the device's firmware then they may be able to * obtain it. * * @param {any} password - The password - max 20 chars * @url http://www.espruino.com/Reference#l_E_setPassword */ - static setPassword(password: any): any; + static setPassword(password: string): void; /** - * If a password has been set with `E.setPassword()`, this will lock the console - * so the password needs to be entered to unlock it. + * If a password has been set with `E.setPassword()`, this will lock the console so + * the password needs to be entered to unlock it. * @url http://www.espruino.com/Reference#l_E_lockConsole */ - static lockConsole(): any; + static lockConsole(): void; /** * Set the time zone to be used with `Date` objects. * For example `E.setTimeZone(1)` will be GMT+0100 - * Note that `E.setTimeZone()` will have no effect when daylight savings time rules have been set with `E.setDST()`. The - * timezone value will be stored, but never used so long as DST settings are in effect. + * Note that `E.setTimeZone()` will have no effect when daylight savings time rules + * have been set with `E.setDST()`. The timezone value will be stored, but never + * used so long as DST settings are in effect. * Time can be set with `setTime`. * * @param {number} zone - The time zone in hours * @url http://www.espruino.com/Reference#l_E_setTimeZone */ - static setTimeZone(zone: number): any; + static setTimeZone(zone: number): void; /** * Set the daylight savings time parameters to be used with `Date` objects. * The parameters are - * - dstOffset: The number of minutes daylight savings time adds to the clock (usually 60) - set to 0 to disable DST - * - timezone: The time zone, in minutes, when DST is not in effect - positive east of Greenwich - * - startDowNumber: The index of the day-of-week in the month when DST starts - 0 for first, 1 for second, 2 for third, 3 for fourth and 4 for last - * - startDow: The day-of-week for the DST start calculation - 0 for Sunday, 6 for Saturday - * - startMonth: The number of the month that DST starts - 0 for January, 11 for December - * - startDayOffset: The number of days between the selected day-of-week and the actual day that DST starts - usually 0 + * - dstOffset: The number of minutes daylight savings time adds to the clock + * (usually 60) - set to 0 to disable DST + * - timezone: The time zone, in minutes, when DST is not in effect - positive east + * of Greenwich + * - startDowNumber: The index of the day-of-week in the month when DST starts - 0 + * for first, 1 for second, 2 for third, 3 for fourth and 4 for last + * - startDow: The day-of-week for the DST start calculation - 0 for Sunday, 6 for + * Saturday + * - startMonth: The number of the month that DST starts - 0 for January, 11 for + * December + * - startDayOffset: The number of days between the selected day-of-week and the + * actual day that DST starts - usually 0 * - startTimeOfDay: The number of minutes elapsed in the day before DST starts - * - endDowNumber: The index of the day-of-week in the month when DST ends - 0 for first, 1 for second, 2 for third, 3 for fourth and 4 for last - * - endDow: The day-of-week for the DST end calculation - 0 for Sunday, 6 for Saturday - * - endMonth: The number of the month that DST ends - 0 for January, 11 for December - * - endDayOffset: The number of days between the selected day-of-week and the actual day that DST ends - usually 0 + * - endDowNumber: The index of the day-of-week in the month when DST ends - 0 for + * first, 1 for second, 2 for third, 3 for fourth and 4 for last + * - endDow: The day-of-week for the DST end calculation - 0 for Sunday, 6 for + * Saturday + * - endMonth: The number of the month that DST ends - 0 for January, 11 for + * December + * - endDayOffset: The number of days between the selected day-of-week and the + * actual day that DST ends - usually 0 * - endTimeOfDay: The number of minutes elapsed in the day before DST ends - * To determine what the `dowNumber, dow, month, dayOffset, timeOfDay` parameters should be, start with a sentence of the form - * "DST starts on the last Sunday of March (plus 0 days) at 03:00". Since it's the last Sunday, we have startDowNumber = 4, and since - * it's Sunday, we have startDow = 0. That it is March gives us startMonth = 2, and that the offset is zero days, we have + * To determine what the `dowNumber, dow, month, dayOffset, timeOfDay` parameters + * should be, start with a sentence of the form "DST starts on the last Sunday of + * March (plus 0 days) at 03:00". Since it's the last Sunday, we have + * startDowNumber = 4, and since it's Sunday, we have startDow = 0. That it is + * March gives us startMonth = 2, and that the offset is zero days, we have * startDayOffset = 0. The time that DST starts gives us startTimeOfDay = 3*60. - * "DST ends on the Friday before the second Sunday in November at 02:00" would give us endDowNumber=1, endDow=0, endMonth=10, endDayOffset=-2 and endTimeOfDay=120. - * Using Ukraine as an example, we have a time which is 2 hours ahead of GMT in winter (EET) and 3 hours in summer (EEST). DST starts at 03:00 EET on the last Sunday in March, - * and ends at 04:00 EEST on the last Sunday in October. So someone in Ukraine might call `E.setDST(60,120,4,0,2,0,180,4,0,9,0,240);` - * Note that when DST parameters are set (i.e. when `dstOffset` is not zero), `E.setTimeZone()` has no effect. + * "DST ends on the Friday before the second Sunday in November at 02:00" would + * give us endDowNumber=1, endDow=0, endMonth=10, endDayOffset=-2 and + * endTimeOfDay=120. + * Using Ukraine as an example, we have a time which is 2 hours ahead of GMT in + * winter (EET) and 3 hours in summer (EEST). DST starts at 03:00 EET on the last + * Sunday in March, and ends at 04:00 EEST on the last Sunday in October. So + * someone in Ukraine might call `E.setDST(60,120,4,0,2,0,180,4,0,9,0,240);` + * Note that when DST parameters are set (i.e. when `dstOffset` is not zero), + * `E.setTimeZone()` has no effect. * * @param {any} params - An array containing the settings for DST * @url http://www.espruino.com/Reference#l_E_setDST */ - static setDST(...params: any[]): any; + static setDST(dstOffset: number, timezone: number, startDowNumber: number, startDow: number, startMonth: number, startDayOffset: number, startTimeOfDay: number, endDowNumber: number, endDow: number, endMonth: number, endDayOffset: number, endTimeOfDay: number): void /** - * Create an object where every field accesses a specific 32 bit address in the microcontroller's memory. This - * is perfect for accessing on-chip peripherals. + * Create an object where every field accesses a specific 32 bit address in the + * microcontroller's memory. This is perfect for accessing on-chip peripherals. * ``` * // for NRF52 based chips * var GPIO = E.memoryMap(0x50000000,{OUT:0x504, OUTSET:0x508, OUTCLR:0x50C, IN:0x510, DIR:0x514, DIRSET:0x518, DIRCLR:0x51C}); @@ -9015,53 +9656,53 @@ declare class E { * @returns {any} An object where each field is memory-mapped to a register. * @url http://www.espruino.com/Reference#l_E_memoryMap */ - static memoryMap(baseAddress: any, registers: any): any; + static memoryMap(baseAddress: number, registers: { [key in T]: number }): { [key in T]: number }; /** * Provide assembly to Espruino. - * **This function is not part of Espruino**. Instead, it is detected - * by the Espruino IDE (or command-line tools) at upload time and is - * replaced with machine code and an `E.nativeCall` call. - * See [the documentation on the Assembler](http://www.espruino.com/Assembler) for more information. + * **This function is not part of Espruino**. Instead, it is detected by the + * Espruino IDE (or command-line tools) at upload time and is replaced with machine + * code and an `E.nativeCall` call. + * See [the documentation on the Assembler](http://www.espruino.com/Assembler) for + * more information. * - * @param {any} callspec - The arguments this assembly takes - eg `void(int)` + * @param {any} callspec - The arguments this assembly takes - e.g. `void(int)` * @param {any} assemblycode - One of more strings of assembler code * @url http://www.espruino.com/Reference#l_E_asm */ - static asm(callspec: any, ...assemblycode: any[]): any; + static asm(callspec: string, ...assemblycode: string[]): any; /** * Provides the ability to write C code inside your JavaScript file. - * **This function is not part of Espruino**. Instead, it is detected - * by the Espruino IDE (or command-line tools) at upload time, is sent - * to our web service to be compiled, and is replaced with machine code - * and an `E.nativeCall` call. - * See [the documentation on Inline C](http://www.espruino.com/InlineC) for more information and examples. + * **This function is not part of Espruino**. Instead, it is detected by the + * Espruino IDE (or command-line tools) at upload time, is sent to our web service + * to be compiled, and is replaced with machine code and an `E.nativeCall` call. + * See [the documentation on Inline C](http://www.espruino.com/InlineC) for more + * information and examples. * * @param {any} code - A Templated string of C code * @url http://www.espruino.com/Reference#l_E_compiledC */ - static compiledC(code: any): any; + static compiledC(code: string): any; /** - * Forces a hard reboot of the microcontroller - as close as possible - * to if the reset pin had been toggled. - * **Note:** This is different to `reset()`, which performs a software - * reset of Espruino (resetting the interpreter and pin states, but not - * all the hardware) + * Forces a hard reboot of the microcontroller - as close as possible to if the + * reset pin had been toggled. + * **Note:** This is different to `reset()`, which performs a software reset of + * Espruino (resetting the interpreter and pin states, but not all the hardware) * @url http://www.espruino.com/Reference#l_E_reboot */ - static reboot(): any; + static reboot(): void; /** - * USB HID will only take effect next time you unplug and re-plug your Espruino. If you're - * disconnecting it from power you'll have to make sure you have `save()`d after calling - * this function. + * USB HID will only take effect next time you unplug and re-plug your Espruino. If + * you're disconnecting it from power you'll have to make sure you have `save()`d + * after calling this function. * * @param {any} opts - An object containing at least reportDescriptor, an array representing the report descriptor. Pass undefined to disable HID. * @url http://www.espruino.com/Reference#l_E_setUSBHID */ - static setUSBHID(opts: any): any; + static setUSBHID(opts?: { reportDescriptor: any[] }): void; /** * @@ -9069,36 +9710,39 @@ declare class E { * @returns {boolean} 1 on success, 0 on failure * @url http://www.espruino.com/Reference#l_E_sendUSBHID */ - static sendUSBHID(data: any): boolean; + static sendUSBHID(data: string | ArrayBuffer | number[]): boolean; /** - * In devices that come with batteries, this function returns - * the battery charge percentage as an integer between 0 and 100. - * **Note:** this is an estimation only, based on battery voltage. - * The temperature of the battery (as well as the load being drawn - * from it at the time `E.getBattery` is called) will affect the - * readings. + * In devices that come with batteries, this function returns the battery charge + * percentage as an integer between 0 and 100. + * **Note:** this is an estimation only, based on battery voltage. The temperature + * of the battery (as well as the load being drawn from it at the time + * `E.getBattery` is called) will affect the readings. * @returns {number} A percentage between 0 and 100 * @url http://www.espruino.com/Reference#l_E_getBattery */ static getBattery(): number; /** - * Sets the RTC's prescaler's maximum value. This is the counter that counts up on each oscillation of the low - * speed oscillator. When the prescaler counts to the value supplied, one second is deemed to have passed. - * By default this is set to the oscillator's average speed as specified in the datasheet, and usually that is - * fine. However on early [Espruino Pico](/Pico) boards the STM32F4's internal oscillator could vary by as - * much as 15% from the value in the datasheet. In that case you may want to alter this value to reflect the - * true RTC speed for more accurate timekeeping. - * To change the RTC's prescaler value to a computed value based on comparing against the high speed oscillator, - * just run the following command, making sure it's done a few seconds after the board starts up: + * Sets the RTC's prescaler's maximum value. This is the counter that counts up on + * each oscillation of the low speed oscillator. When the prescaler counts to the + * value supplied, one second is deemed to have passed. + * By default this is set to the oscillator's average speed as specified in the + * datasheet, and usually that is fine. However on early [Espruino Pico](/Pico) + * boards the STM32F4's internal oscillator could vary by as much as 15% from the + * value in the datasheet. In that case you may want to alter this value to reflect + * the true RTC speed for more accurate timekeeping. + * To change the RTC's prescaler value to a computed value based on comparing + * against the high speed oscillator, just run the following command, making sure + * it's done a few seconds after the board starts up: * ``` * E.setRTCPrescaler(E.getRTCPrescaler(true)); * ``` - * When changing the RTC prescaler, the RTC 'follower' counters are reset and it can take a second or two before - * readings from getTime are stable again. - * To test, you can connect an input pin to a known frequency square wave and then use `setWatch`. If you don't - * have a frequency source handy, you can check against the high speed oscillator: + * When changing the RTC prescaler, the RTC 'follower' counters are reset and it + * can take a second or two before readings from getTime are stable again. + * To test, you can connect an input pin to a known frequency square wave and then + * use `setWatch`. If you don't have a frequency source handy, you can check + * against the high speed oscillator: * ``` * // connect pin B3 to B4 * analogWrite(B3, 0.5, {freq:0.5}); @@ -9106,18 +9750,20 @@ declare class E { * print(e.time - e.lastTime); * }, B4, {repeat:true}); * ``` - * **Note:** This is only used on official Espruino boards containing an STM32 microcontroller. Other boards - * (even those using an STM32) don't use the RTC and so this has no effect. + * **Note:** This is only used on official Espruino boards containing an STM32 + * microcontroller. Other boards (even those using an STM32) don't use the RTC and + * so this has no effect. * * @param {number} prescaler - The amount of counts for one second of the RTC - this is a 15 bit integer value (0..32767) * @url http://www.espruino.com/Reference#l_E_setRTCPrescaler */ - static setRTCPrescaler(prescaler: number): any; + static setRTCPrescaler(prescaler: number): void; /** * Gets the RTC's current prescaler value if `calibrate` is undefined or false. - * If `calibrate` is true, the low speed oscillator's speed is calibrated against the high speed - * oscillator (usually +/- 20 ppm) and a suggested value to be fed into `E.setRTCPrescaler(...)` is returned. + * If `calibrate` is true, the low speed oscillator's speed is calibrated against + * the high speed oscillator (usually +/- 20 ppm) and a suggested value to be fed + * into `E.setRTCPrescaler(...)` is returned. * See `E.setRTCPrescaler` for more information. * * @param {boolean} calibrate - If `false`, the current value. If `true`, the calculated 'correct' value @@ -9149,7 +9795,7 @@ declare class E { * @returns {any} A string containing all UTF8 sequences flattened to 8 bits * @url http://www.espruino.com/Reference#l_E_decodeUTF8 */ - static decodeUTF8(str: any, lookup: any, replaceFn: any): any; + static decodeUTF8(str: string, lookup: string[], replaceFn: string | ((charCode: number) => string)): string; } @@ -9157,12 +9803,15 @@ declare class E { interface consoleConstructor { /** * Print the supplied string(s) to the console - * **Note:** If you're connected to a computer (not a wall adaptor) via USB but **you are not running a terminal app** then when you print data Espruino may pause execution and wait until the computer requests the data it is trying to print. + * **Note:** If you're connected to a computer (not a wall adaptor) via USB but + * **you are not running a terminal app** then when you print data Espruino may + * pause execution and wait until the computer requests the data it is trying to + * print. * * @param {any} text - One or more arguments to print * @url http://www.espruino.com/Reference#l_console_log */ - log(...text: any[]): any; + log(...text: any[]): void; } interface console { @@ -9184,7 +9833,7 @@ interface ErrorConstructor { * @returns {any} An Error object * @url http://www.espruino.com/Reference#l_Error_Error */ - new(message: any): any; + new(message?: string): Error; } interface Error { @@ -9192,7 +9841,7 @@ interface Error { * @returns {any} A String * @url http://www.espruino.com/Reference#l_Error_toString */ - toString(): any; + toString(): string; } /** @@ -9210,7 +9859,7 @@ interface SyntaxErrorConstructor { * @returns {any} A SyntaxError object * @url http://www.espruino.com/Reference#l_SyntaxError_SyntaxError */ - new(message: any): any; + new(message?: string): SyntaxError; } interface SyntaxError { @@ -9218,7 +9867,7 @@ interface SyntaxError { * @returns {any} A String * @url http://www.espruino.com/Reference#l_SyntaxError_toString */ - toString(): any; + toString(): string; } /** @@ -9236,7 +9885,7 @@ interface TypeErrorConstructor { * @returns {any} A TypeError object * @url http://www.espruino.com/Reference#l_TypeError_TypeError */ - new(message: any): any; + new(message?: string): TypeError; } interface TypeError { @@ -9244,7 +9893,7 @@ interface TypeError { * @returns {any} A String * @url http://www.espruino.com/Reference#l_TypeError_toString */ - toString(): any; + toString(): string; } /** @@ -9266,13 +9915,13 @@ declare class InternalError { * @returns {any} An InternalError object * @url http://www.espruino.com/Reference#l_InternalError_InternalError */ - static new(message: any): any; + static new(message?: string): InternalError; /** * @returns {any} A String * @url http://www.espruino.com/Reference#l_InternalError_toString */ - toString(): any; + toString(): string; } interface ReferenceErrorConstructor { @@ -9284,7 +9933,7 @@ interface ReferenceErrorConstructor { * @returns {any} A ReferenceError object * @url http://www.espruino.com/Reference#l_ReferenceError_ReferenceError */ - new(message: any): any; + new(message?: string): ReferenceError; } interface ReferenceError { @@ -9292,22 +9941,24 @@ interface ReferenceError { * @returns {any} A String * @url http://www.espruino.com/Reference#l_ReferenceError_toString */ - toString(): any; + toString(): string; } /** - * The base class for reference errors - where a variable - * which doesn't exist has been accessed. + * The base class for reference errors - where a variable which doesn't exist has + * been accessed. * @url http://www.espruino.com/Reference#ReferenceError */ declare const ReferenceError: ReferenceErrorConstructor interface JSONConstructor { /** - * Convert the given object into a JSON string which can subsequently be parsed with JSON.parse or eval. + * Convert the given object into a JSON string which can subsequently be parsed + * with JSON.parse or eval. * **Note:** This differs from JavaScript's standard `JSON.stringify` in that: * * The `replacer` argument is ignored - * * Typed arrays like `new Uint8Array(5)` will be dumped as if they were arrays, not as if they were objects (since it is more compact) + * * Typed arrays like `new Uint8Array(5)` will be dumped as if they were arrays, + * not as if they were objects (since it is more compact) * * @param {any} data - The data to be converted to a JSON string * @param {any} replacer - This value is ignored @@ -9319,7 +9970,8 @@ interface JSONConstructor { /** * Parse the given JSON string into a JavaScript object - * NOTE: This implementation uses eval() internally, and as such it is unsafe as it can allow arbitrary JS commands to be executed. + * NOTE: This implementation uses eval() internally, and as such it is unsafe as it + * can allow arbitrary JS commands to be executed. * * @param {any} string - A JSON string * @returns {any} The JavaScript object created by parsing the data string @@ -9353,7 +10005,8 @@ interface RegExpConstructor { interface RegExp { /** - * Test this regex on a string - returns a result array on success, or `null` otherwise. + * Test this regex on a string - returns a result array on success, or `null` + * otherwise. * `/Wo/.exec("Hello World")` will return: * ``` * [ @@ -9378,7 +10031,8 @@ interface RegExp { exec(str: any): any; /** - * Test this regex on a string - returns `true` on a successful match, or `false` otherwise + * Test this regex on a string - returns `true` on a successful match, or `false` + * otherwise * * @param {any} str - A string to match on * @returns {boolean} true for a match, or false @@ -9390,7 +10044,8 @@ interface RegExp { /** * The built-in class for handling Regular Expressions * **Note:** Espruino's regular expression parser does not contain all the features - * present in a full ES6 JS engine. However it does contain support for the all the basics. + * present in a full ES6 JS engine. However it does contain support for the all the + * basics. * @url http://www.espruino.com/Reference#RegExp */ declare const RegExp: RegExpConstructor @@ -9536,7 +10191,8 @@ declare class Nucleo { } /** - * This is a built-in class to allow you to use the ESP8266 NodeMCU boards's pin namings to access pins. It is only available on ESP8266-based boards. + * This is a built-in class to allow you to use the ESP8266 NodeMCU boards's pin + * namings to access pins. It is only available on ESP8266-based boards. * @url http://www.espruino.com/Reference#NodeMCU */ declare class NodeMCU { @@ -9616,7 +10272,8 @@ declare class NodeMCU { } /** - * Class containing utility functions for the [ESP32](http://www.espruino.com/ESP32) + * Class containing utility functions for the + * [ESP32](http://www.espruino.com/ESP32) * @url http://www.espruino.com/Reference#ESP32 */ declare class ESP32 { @@ -9626,13 +10283,13 @@ declare class ESP32 { * @param {number} atten - Attenuate factor * @url http://www.espruino.com/Reference#l_ESP32_setAtten */ - static setAtten(pin: Pin, atten: number): any; + static setAtten(pin: Pin, atten: number): void; /** * Perform a hardware reset/reboot of the ESP32. * @url http://www.espruino.com/Reference#l_ESP32_reboot */ - static reboot(): any; + static reboot(): void; /** * Put device in deepsleep state for "us" microseconds. @@ -9640,15 +10297,16 @@ declare class ESP32 { * @param {number} us - Sleeptime in us * @url http://www.espruino.com/Reference#l_ESP32_deepSleep */ - static deepSleep(us: number): any; + static deepSleep(us: number): void; /** - * Returns an object that contains details about the state of the ESP32 with the following fields: - * * `sdkVersion` - Version of the SDK. - * * `freeHeap` - Amount of free heap in bytes. - * * `BLE` - Status of BLE, enabled if true. - * * `Wifi` - Status of Wifi, enabled if true. - * * `minHeap` - Minimum heap, calculated by heap_caps_get_minimum_free_size + * Returns an object that contains details about the state of the ESP32 with the + * following fields: + * * `sdkVersion` - Version of the SDK. + * * `freeHeap` - Amount of free heap in bytes. + * * `BLE` - Status of BLE, enabled if true. + * * `Wifi` - Status of Wifi, enabled if true. + * * `minHeap` - Minimum heap, calculated by heap_caps_get_minimum_free_size * @returns {any} The state of the ESP32 * @url http://www.espruino.com/Reference#l_ESP32_getState */ @@ -9659,25 +10317,25 @@ declare class ESP32 { * @param {number} level - which events should be shown (GATTS, GATTC, GAP) * @url http://www.espruino.com/Reference#l_ESP32_setBLE_Debug */ - static setBLE_Debug(level: number): any; + static setBLE_Debug(level: number): void; /** - * Switches Bluetooth off/on, removes saved code from Flash, resets the board, - * and on restart creates jsVars depending on available heap (actual additional 1800) + * Switches Bluetooth off/on, removes saved code from Flash, resets the board, and + * on restart creates jsVars depending on available heap (actual additional 1800) * * @param {boolean} enable - switches Bluetooth on or off * @url http://www.espruino.com/Reference#l_ESP32_enableBLE */ - static enableBLE(enable: boolean): any; + static enableBLE(enable: boolean): void; /** - * Switches Wifi off/on, removes saved code from Flash, resets the board, - * and on restart creates jsVars depending on available heap (actual additional 3900) + * Switches Wifi off/on, removes saved code from Flash, resets the board, and on + * restart creates jsVars depending on available heap (actual additional 3900) * * @param {boolean} enable - switches Wifi on or off * @url http://www.espruino.com/Reference#l_ESP32_enableWifi */ - static enableWifi(enable: boolean): any; + static enableWifi(enable: boolean): void; } @@ -9701,7 +10359,7 @@ declare class Queue { * reads one character from queue, if available * @url http://www.espruino.com/Reference#l_Queue_read */ - read(): any; + read(): void; /** * Writes one character to queue @@ -9709,13 +10367,13 @@ declare class Queue { * @param {any} char - char to be send * @url http://www.espruino.com/Reference#l_Queue_writeChar */ - writeChar(char: any): any; + writeChar(char: any): void; /** * logs list of queues * @url http://www.espruino.com/Reference#l_Queue_log */ - log(): any; + log(): void; } /** @@ -9737,13 +10395,13 @@ declare class Task { * Suspend task, be careful not to suspend Espruino task itself * @url http://www.espruino.com/Reference#l_Task_suspend */ - suspend(): any; + suspend(): void; /** * Resumes a suspended task * @url http://www.espruino.com/Reference#l_Task_resume */ - resume(): any; + resume(): void; /** * returns name of actual task @@ -9756,13 +10414,13 @@ declare class Task { * Sends a binary notify to task * @url http://www.espruino.com/Reference#l_Task_notify */ - notify(): any; + notify(): void; /** * logs list of tasks * @url http://www.espruino.com/Reference#l_Task_log */ - log(): any; + log(): void; } /** @@ -9789,7 +10447,7 @@ declare class Timer { * @param {number} duration - duration of timmer in micro secs * @url http://www.espruino.com/Reference#l_Timer_start */ - start(duration: number): any; + start(duration: number): void; /** * Reschedules a timer, needs to be started at least once @@ -9797,13 +10455,13 @@ declare class Timer { * @param {number} duration - duration of timmer in micro secs * @url http://www.espruino.com/Reference#l_Timer_reschedule */ - reschedule(duration: number): any; + reschedule(duration: number): void; /** * logs list of timers * @url http://www.espruino.com/Reference#l_Timer_log */ - log(): any; + log(): void; } interface BooleanConstructor { @@ -9828,10 +10486,12 @@ declare const Boolean: BooleanConstructor // GLOBALS /** - * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) board + * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) + * board * Show an image on the in-built 5x5 LED screen. * Image can be: - * * A number where each bit represents a pixel (so 25 bits). eg. `5` or `0x1FFFFFF` + * * A number where each bit represents a pixel (so 25 bits). eg. `5` or + * `0x1FFFFFF` * * A string, eg: `show("10001")`. Newlines are ignored, and anything that is not * a space or `0` is treated as a 1. * * An array of 4 bytes (more will be ignored), eg `show([1,2,3,0])` @@ -9853,10 +10513,11 @@ declare const Boolean: BooleanConstructor * @param {any} image - The image to show * @url http://www.espruino.com/Reference#l__global_show */ -declare function show(image: any): any; +declare function show(image: any): void; /** - * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) board + * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) + * board * Get the current acceleration of the micro:bit from the on-board accelerometer * **This is deprecated.** Please use `Microbit.accel` instead. * @returns {any} An object with x, y, and z fields in it @@ -9865,8 +10526,10 @@ declare function show(image: any): any; declare function acceleration(): any; /** - * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) board - * Get the current compass position for the micro:bit from the on-board magnetometer + * **Note:** This function is only available on the [BBC micro:bit](/MicroBit) + * board + * Get the current compass position for the micro:bit from the on-board + * magnetometer * **This is deprecated.** Please use `Microbit.mag` instead. * @returns {any} An object with x, y, and z fields in it * @url http://www.espruino.com/Reference#l__global_compass @@ -9958,21 +10621,24 @@ declare const CORNER5: Pin; declare const CORNER6: Pin; /** - * On Puck.js V2 (not v1.0) this is the pin that controls the FET, for high-powered outputs. + * On Puck.js V2 (not v1.0) this is the pin that controls the FET, for high-powered + * outputs. * @returns {Pin} * @url http://www.espruino.com/Reference#l__global_FET */ declare const FET: Pin; /** - * The pin marked SDA on the Arduino pin footprint. This is connected directly to pin A4. + * The pin marked SDA on the Arduino pin footprint. This is connected directly to + * pin A4. * @returns {Pin} * @url http://www.espruino.com/Reference#l__global_SDA */ declare const SDA: Pin; /** - * The pin marked SDA on the Arduino pin footprint. This is connected directly to pin A5. + * The pin marked SDA on the Arduino pin footprint. This is connected directly to + * pin A5. * @returns {Pin} * @url http://www.espruino.com/Reference#l__global_SCL */ @@ -9986,30 +10652,33 @@ declare const SCL: Pin; declare const VIBRATE: Pin; /** - * On most Espruino board there are LEDs, in which case `LED` will be an actual Pin. - * On Bangle.js there are no LEDs, so to remain compatible with example code that might - * expect an LED, this is an object that behaves like a pin, but which just displays - * a circle on the display + * On most Espruino board there are LEDs, in which case `LED` will be an actual + * Pin. + * On Bangle.js there are no LEDs, so to remain compatible with example code that + * might expect an LED, this is an object that behaves like a pin, but which just + * displays a circle on the display * @returns {any} A `Pin` object for a fake LED which appears on * @url http://www.espruino.com/Reference#l__global_LED */ declare const LED: any; /** - * On most Espruino board there are LEDs, in which case `LED1` will be an actual Pin. - * On Bangle.js there are no LEDs, so to remain compatible with example code that might - * expect an LED, this is an object that behaves like a pin, but which just displays - * a circle on the display + * On most Espruino board there are LEDs, in which case `LED1` will be an actual + * Pin. + * On Bangle.js there are no LEDs, so to remain compatible with example code that + * might expect an LED, this is an object that behaves like a pin, but which just + * displays a circle on the display * @returns {any} A `Pin` object for a fake LED which appears on * @url http://www.espruino.com/Reference#l__global_LED1 */ declare const LED1: any; /** - * On most Espruino board there are LEDs, in which case `LED2` will be an actual Pin. - * On Bangle.js there are no LEDs, so to remain compatible with example code that might - * expect an LED, this is an object that behaves like a pin, but which just displays - * a circle on the display + * On most Espruino board there are LEDs, in which case `LED2` will be an actual + * Pin. + * On Bangle.js there are no LEDs, so to remain compatible with example code that + * might expect an LED, this is an object that behaves like a pin, but which just + * displays a circle on the display * @returns {any} A `Pin` object for a fake LED which appears on * @url http://www.espruino.com/Reference#l__global_LED2 */ @@ -10079,13 +10748,13 @@ declare const Infinity: number; * @returns {number} Logic 1 for Arduino compatibility - this is the same as just typing `1` * @url http://www.espruino.com/Reference#l__global_HIGH */ -declare const HIGH: number; +declare const HIGH: 1; /** * @returns {number} Logic 0 for Arduino compatibility - this is the same as just typing `0` * @url http://www.espruino.com/Reference#l__global_LOW */ -declare const LOW: number; +declare const LOW: 0; /** * A variable containing the arguments given to the function: @@ -10097,11 +10766,11 @@ declare const LOW: number; * hello("Test") // 1 ["Test"] * hello(1,2,3) // 3 [1,2,3] * ``` - * **Note:** Due to the way Espruino works this is doesn't behave exactly - * the same as in normal JavaScript. The length of the arguments array - * will never be less than the number of arguments specified in the - * function declaration: `(function(a){ return arguments.length; })() == 1`. - * Normal JavaScript interpreters would return `0` in the above case. + * **Note:** Due to the way Espruino works this is doesn't behave exactly the same + * as in normal JavaScript. The length of the arguments array will never be less + * than the number of arguments specified in the function declaration: + * `(function(a){ return arguments.length; })() == 1`. Normal JavaScript + * interpreters would return `0` in the above case. * @returns {any} An array containing all the arguments given to the function * @url http://www.espruino.com/Reference#l__global_arguments */ @@ -10136,7 +10805,8 @@ declare function parseInt(string: any, radix: any): any; declare function parseFloat(string: any): number; /** - * Is the parameter a finite num,ber or not? If needed, the parameter is first converted to a number. + * Is the parameter a finite num,ber or not? If needed, the parameter is first + * converted to a number. * * @param {any} x * @returns {boolean} True is the value is a Finite number, false if not. @@ -10172,7 +10842,8 @@ declare function btoa(binaryData: any): any; declare function atob(base64Data: any): any; /** - * Convert a string with any character not alphanumeric or `- _ . ! ~ * ' ( )` converted to the form `%XY` where `XY` is its hexadecimal representation + * Convert a string with any character not alphanumeric or `- _ . ! ~ * ' ( )` + * converted to the form `%XY` where `XY` is its hexadecimal representation * * @param {any} str - A string to encode as a URI * @returns {any} A string containing the encoded data @@ -10181,7 +10852,8 @@ declare function atob(base64Data: any): any; declare function encodeURIComponent(str: any): any; /** - * Convert any groups of characters of the form '%ZZ', into characters with hex code '0xZZ' + * Convert any groups of characters of the form '%ZZ', into characters with hex + * code '0xZZ' * * @param {any} str - A string to decode from a URI * @returns {any} A string containing the decoded data @@ -10198,8 +10870,8 @@ declare function decodeURIComponent(str: any): any; * print(s.read("test")); * // prints "hello world" * ``` - * Check out [the page on Modules](/Modules) for an explanation - * of what modules are and how you can use them. + * Check out [the page on Modules](/Modules) for an explanation of what modules are + * and how you can use them. * * @param {any} moduleName - A String containing the name of the given module * @returns {any} The result of evaluating the string @@ -10216,7 +10888,8 @@ declare function require>(moduleName: * @returns {any} The value of memory at the given location * @url http://www.espruino.com/Reference#l__global_peek8 */ -declare function peek8(addr: number, count: number): any; +declare function peek8(addr: number, count?: 1): number; +declare function peek8(addr: number, count: number): Uint8Array; /** * Write 8 bits of memory at the given location - VERY DANGEROUS! @@ -10225,7 +10898,7 @@ declare function peek8(addr: number, count: number): any; * @param {any} value - The value to write, or an array of values * @url http://www.espruino.com/Reference#l__global_poke8 */ -declare function poke8(addr: number, value: any): any; +declare function poke8(addr: number, value: number | number[]): void; /** * Read 16 bits of memory at the given location - DANGEROUS! @@ -10235,7 +10908,8 @@ declare function poke8(addr: number, value: any): any; * @returns {any} The value of memory at the given location * @url http://www.espruino.com/Reference#l__global_peek16 */ -declare function peek16(addr: number, count: number): any; +declare function peek16(addr: number, count?: 1): number; +declare function peek16(addr: number, count: number): Uint8Array; /** * Write 16 bits of memory at the given location - VERY DANGEROUS! @@ -10244,7 +10918,7 @@ declare function peek16(addr: number, count: number): any; * @param {any} value - The value to write, or an array of values * @url http://www.espruino.com/Reference#l__global_poke16 */ -declare function poke16(addr: number, value: any): any; +declare function poke16(addr: number, value: number | number[]): void; /** * Read 32 bits of memory at the given location - DANGEROUS! @@ -10254,7 +10928,8 @@ declare function poke16(addr: number, value: any): any; * @returns {any} The value of memory at the given location * @url http://www.espruino.com/Reference#l__global_peek32 */ -declare function peek32(addr: number, count: number): any; +declare function peek32(addr: number, count?: 1): number; +declare function peek32(addr: number, count: number): Uint8Array; /** * Write 32 bits of memory at the given location - VERY DANGEROUS! @@ -10263,13 +10938,14 @@ declare function peek32(addr: number, count: number): any; * @param {any} value - The value to write, or an array of values * @url http://www.espruino.com/Reference#l__global_poke32 */ -declare function poke32(addr: number, value: any): any; +declare function poke32(addr: number, value: number | number[]): void; /** * Get the analog value of the given pin * This is different to Arduino which only returns an integer between 0 and 1023 * However only pins connected to an ADC will work (see the datasheet) - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset pin's state to `"analog"` + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset pin's state to `"analog"` * * @param {Pin} pin * The pin to use @@ -10282,10 +10958,13 @@ declare function analogRead(pin: Pin): number; /** * Set the analog Value of a pin. It will be output using PWM. * Objects can contain: - * * `freq` - pulse frequency in Hz, eg. ```analogWrite(A0,0.5,{ freq : 10 });``` - specifying a frequency will force PWM output, even if the pin has a DAC + * * `freq` - pulse frequency in Hz, eg. ```analogWrite(A0,0.5,{ freq : 10 });``` - + * specifying a frequency will force PWM output, even if the pin has a DAC * * `soft` - boolean, If true software PWM is used if hardware is not available. - * * `forceSoft` - boolean, If true software PWM is used even if hardware PWM or a DAC is available - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset pin's state to `"output"` + * * `forceSoft` - boolean, If true software PWM is used even if hardware PWM or a + * DAC is available + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset pin's state to `"output"` * * @param {Pin} pin * The pin to use @@ -10295,29 +10974,39 @@ declare function analogRead(pin: Pin): number; * An object containing options for analog output - see below * @url http://www.espruino.com/Reference#l__global_analogWrite */ -declare function analogWrite(pin: Pin, value: number, options: any): any; +declare function analogWrite(pin: Pin, value: number, options?: { freq?: number, soft?: boolean, forceSoft?: boolean }): void; /** - * Pulse the pin with the value for the given time in milliseconds. It uses a hardware timer to produce accurate pulses, and returns immediately (before the pulse has finished). Use `digitalPulse(A0,1,0)` to wait until a previous pulse has finished. - * eg. `digitalPulse(A0,1,5);` pulses A0 high for 5ms. `digitalPulse(A0,1,[5,2,4]);` pulses A0 high for 5ms, low for 2ms, and high for 4ms - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset pin's state to `"output"` - * digitalPulse is for SHORT pulses that need to be very accurate. If you're doing anything over a few milliseconds, use setTimeout instead. + * Pulse the pin with the value for the given time in milliseconds. It uses a + * hardware timer to produce accurate pulses, and returns immediately (before the + * pulse has finished). Use `digitalPulse(A0,1,0)` to wait until a previous pulse + * has finished. + * eg. `digitalPulse(A0,1,5);` pulses A0 high for 5ms. + * `digitalPulse(A0,1,[5,2,4]);` pulses A0 high for 5ms, low for 2ms, and high for + * 4ms + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset pin's state to `"output"` + * digitalPulse is for SHORT pulses that need to be very accurate. If you're doing + * anything over a few milliseconds, use setTimeout instead. * * @param {Pin} pin - The pin to use * @param {boolean} value - Whether to pulse high (true) or low (false) * @param {any} time - A time in milliseconds, or an array of times (in which case a square wave will be output starting with a pulse of 'value') * @url http://www.espruino.com/Reference#l__global_digitalPulse */ -declare function digitalPulse(pin: Pin, value: boolean, time: any): any; +declare function digitalPulse(pin: Pin, value: boolean, time: number | number[]): void; /** * Set the digital value of the given pin. - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset pin's state to `"output"` - * If pin argument is an array of pins (eg. `[A2,A1,A0]`) the value argument will be treated - * as an array of bits where the last array element is the least significant bit. - * In this case, pin values are set least significant bit first (from the right-hand side - * of the array of pins). This means you can use the same pin multiple times, for - * example `digitalWrite([A1,A1,A0,A0],0b0101)` would pulse A0 followed by A1. + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset pin's state to `"output"` + * If pin argument is an array of pins (eg. `[A2,A1,A0]`) the value argument will + * be treated as an array of bits where the last array element is the least + * significant bit. + * In this case, pin values are set least significant bit first (from the + * right-hand side of the array of pins). This means you can use the same pin + * multiple times, for example `digitalWrite([A1,A1,A0,A0],0b0101)` would pulse A0 + * followed by A1. * If the pin argument is an object with a `write` method, the `write` method will * be called with the value passed through. * @@ -10325,58 +11014,67 @@ declare function digitalPulse(pin: Pin, value: boolean, time: any): any; * @param {number} value - Whether to pulse high (true) or low (false) * @url http://www.espruino.com/Reference#l__global_digitalWrite */ -declare function digitalWrite(pin: any, value: number): any; +declare function digitalWrite(pin: Pin, value: typeof HIGH | typeof LOW): void; /** * Get the digital value of the given pin. - * **Note:** if you didn't call `pinMode` beforehand then this function will also reset pin's state to `"input"` - * If the pin argument is an array of pins (eg. `[A2,A1,A0]`) the value returned will be an number where - * the last array element is the least significant bit, for example if `A0=A1=1` and `A2=0`, `digitalRead([A2,A1,A0]) == 0b011` - * If the pin argument is an object with a `read` method, the `read` method will be called and the integer value it returns - * passed back. + * **Note:** if you didn't call `pinMode` beforehand then this function will also + * reset pin's state to `"input"` + * If the pin argument is an array of pins (eg. `[A2,A1,A0]`) the value returned + * will be an number where the last array element is the least significant bit, for + * example if `A0=A1=1` and `A2=0`, `digitalRead([A2,A1,A0]) == 0b011` + * If the pin argument is an object with a `read` method, the `read` method will be + * called and the integer value it returns passed back. * * @param {any} pin - The pin to use * @returns {number} The digital Value of the Pin * @url http://www.espruino.com/Reference#l__global_digitalRead */ -declare function digitalRead(pin: any): number; +declare function digitalRead(pin: Pin): number; /** * Set the mode of the given pin. - * * `auto`/`undefined` - Don't change state, but allow `digitalWrite`/etc to automatically change state as appropriate + * * `auto`/`undefined` - Don't change state, but allow `digitalWrite`/etc to + * automatically change state as appropriate * * `analog` - Analog input * * `input` - Digital input * * `input_pullup` - Digital input with internal ~40k pull-up resistor * * `input_pulldown` - Digital input with internal ~40k pull-down resistor * * `output` - Digital output - * * `opendrain` - Digital output that only ever pulls down to 0v. Sending a logical `1` leaves the pin open circuit - * * `opendrain_pullup` - Digital output that pulls down to 0v. Sending a logical `1` enables internal ~40k pull-up resistor + * * `opendrain` - Digital output that only ever pulls down to 0v. Sending a + * logical `1` leaves the pin open circuit + * * `opendrain_pullup` - Digital output that pulls down to 0v. Sending a logical + * `1` enables internal ~40k pull-up resistor * * `af_output` - Digital output from built-in peripheral - * * `af_opendrain` - Digital output from built-in peripheral that only ever pulls down to 0v. Sending a logical `1` leaves the pin open circuit - * **Note:** `digitalRead`/`digitalWrite`/etc set the pin mode automatically *unless* `pinMode` has been called first. - * If you want `digitalRead`/etc to set the pin mode automatically after you have called `pinMode`, simply call it again - * with no mode argument (`pinMode(pin)`), `auto` as the argument (`pinMode(pin, "auto")`), or with the 3rd 'automatic' - * argument set to true (`pinMode(pin, "output", true)`). + * * `af_opendrain` - Digital output from built-in peripheral that only ever pulls + * down to 0v. Sending a logical `1` leaves the pin open circuit + * **Note:** `digitalRead`/`digitalWrite`/etc set the pin mode automatically + * *unless* `pinMode` has been called first. If you want `digitalRead`/etc to set + * the pin mode automatically after you have called `pinMode`, simply call it again + * with no mode argument (`pinMode(pin)`), `auto` as the argument (`pinMode(pin, + * "auto")`), or with the 3rd 'automatic' argument set to true (`pinMode(pin, + * "output", true)`). * * @param {Pin} pin - The pin to set pin mode for * @param {any} mode - The mode - a string that is either 'analog', 'input', 'input_pullup', 'input_pulldown', 'output', 'opendrain', 'af_output' or 'af_opendrain'. Do not include this argument or use 'auto' if you want to revert to automatic pin mode setting. * @param {boolean} automatic - Optional, default is false. If true, subsequent commands will automatically change the state (see notes below) * @url http://www.espruino.com/Reference#l__global_pinMode */ -declare function pinMode(pin: Pin, mode: any, automatic: boolean): any; +declare function pinMode(pin: Pin, mode?: PinMode | "auto", automatic?: boolean): void; /** - * Return the current mode of the given pin. See `pinMode` for more information on returned values. + * Return the current mode of the given pin. See `pinMode` for more information on + * returned values. * * @param {Pin} pin - The pin to check * @returns {any} The pin mode, as a string * @url http://www.espruino.com/Reference#l__global_getPinMode */ -declare function getPinMode(pin: Pin): any; +declare function getPinMode(pin: Pin): PinMode; /** - * Shift an array of data out using the pins supplied *least significant bit first*, - * for example: + * Shift an array of data out using the pins supplied *least significant bit + * first*, for example: * ``` * // shift out to single clk+data * shiftOut(A0, { clk : A1 }, [1,0,1,0]); @@ -10397,9 +11095,9 @@ declare function getPinMode(pin: Pin): any; * repeat : int, // number of clocks per array item * } * ``` - * Each item in the `data` array will be output to the pins, with the first - * pin in the array being the MSB and the last the LSB, then the clock will be - * pulsed in the polarity given. + * Each item in the `data` array will be output to the pins, with the first pin in + * the array being the MSB and the last the LSB, then the clock will be pulsed in + * the polarity given. * `repeat` is the amount of times shift data out for each array item. For instance * we may want to shift 8 bits out through 2 pins - in which case we need to set * repeat to 4. @@ -10409,11 +11107,13 @@ declare function getPinMode(pin: Pin): any; * @param {any} data - The data to shift out (see `E.toUint8Array` for info on the forms this can take) * @url http://www.espruino.com/Reference#l__global_shiftOut */ -declare function shiftOut(pins: any, options: any, data: any): any; +declare function shiftOut(pins: Pin | Pin[], options: { clk?: Pin, clkPol?: boolean, repeat?: number }, data: Uint8ArrayResolvable): void; /** - * Call the function specified when the pin changes. Watches set with `setWatch` can be removed using `clearWatch`. - * If the `options` parameter is an object, it can contain the following information (all optional): + * Call the function specified when the pin changes. Watches set with `setWatch` + * can be removed using `clearWatch`. + * If the `options` parameter is an object, it can contain the following + * information (all optional): * ``` * { * // Whether to keep producing callbacks, or remove the watch after the first callback @@ -10436,24 +11136,33 @@ declare function shiftOut(pins: any, options: any, data: any): any; * hispeed : true * } * ``` - * The `function` callback is called with an argument, which is an object of type `{state:bool, time:float, lastTime:float}`. + * The `function` callback is called with an argument, which is an object of type + * `{state:bool, time:float, lastTime:float}`. * * `state` is whether the pin is currently a `1` or a `0` * * `time` is the time in seconds at which the pin changed state - * * `lastTime` is the time in seconds at which the **pin last changed state**. When using `edge:'rising'` or `edge:'falling'`, this is not the same as when the function was last called. - * * `data` is included if `data:pin` was specified in the options, and can be used for reading in clocked data - * For instance, if you want to measure the length of a positive pulse you could use `setWatch(function(e) { console.log(e.time-e.lastTime); }, BTN, { repeat:true, edge:'falling' });`. - * This will only be called on the falling edge of the pulse, but will be able to measure the width of the pulse because `e.lastTime` is the time of the rising edge. - * Internally, an interrupt writes the time of the pin's state change into a queue with the exact - * time that it happened, and the function supplied to `setWatch` is executed only from the main - * message loop. However, if the callback is a native function `void (bool state)` then you can - * add `irq:true` to options, which will cause the function to be called from within the IRQ. - * When doing this, interrupts will happen on both edges and there will be no debouncing. - * **Note:** if you didn't call `pinMode` beforehand then this function will reset pin's state to `"input"` - * **Note:** The STM32 chip (used in the [Espruino Board](/EspruinoBoard) and [Pico](/Pico)) cannot - * watch two pins with the same number - eg `A0` and `B0`. - * **Note:** On nRF52 chips (used in Puck.js, Pixl.js, MDBT42Q) `setWatch` disables the GPIO - * output on that pin. In order to be able to write to the pin again you need to disable - * the watch with `clearWatch`. + * * `lastTime` is the time in seconds at which the **pin last changed state**. + * When using `edge:'rising'` or `edge:'falling'`, this is not the same as when + * the function was last called. + * * `data` is included if `data:pin` was specified in the options, and can be + * used for reading in clocked data + * For instance, if you want to measure the length of a positive pulse you could + * use `setWatch(function(e) { console.log(e.time-e.lastTime); }, BTN, { + * repeat:true, edge:'falling' });`. This will only be called on the falling edge + * of the pulse, but will be able to measure the width of the pulse because + * `e.lastTime` is the time of the rising edge. + * Internally, an interrupt writes the time of the pin's state change into a queue + * with the exact time that it happened, and the function supplied to `setWatch` is + * executed only from the main message loop. However, if the callback is a native + * function `void (bool state)` then you can add `irq:true` to options, which will + * cause the function to be called from within the IRQ. When doing this, interrupts + * will happen on both edges and there will be no debouncing. + * **Note:** if you didn't call `pinMode` beforehand then this function will reset + * pin's state to `"input"` + * **Note:** The STM32 chip (used in the [Espruino Board](/EspruinoBoard) and + * [Pico](/Pico)) cannot watch two pins with the same number - eg `A0` and `B0`. + * **Note:** On nRF52 chips (used in Puck.js, Pixl.js, MDBT42Q) `setWatch` disables + * the GPIO output on that pin. In order to be able to write to the pin again you + * need to disable the watch with `clearWatch`. * * @param {any} function - A Function or String to be executed * @param {Pin} pin - The pin to watch @@ -10461,7 +11170,7 @@ declare function shiftOut(pins: any, options: any, data: any): any; * @returns {any} An ID that can be passed to clearWatch * @url http://www.espruino.com/Reference#l__global_setWatch */ -declare function setWatch(func: any, pin: Pin, options: any): any; +declare function setWatch(func: ((arg: { state: boolean, time: number, lastTime: number }) => void) | string, pin: Pin, options?: boolean | { repeat?: boolean, edge?: "rising" | "falling" | "both", debounce?: number, irq?: boolean, data?: Pin, hispeed?: boolean }): number; /** * Clear the Watch that was created with setWatch. If no parameter is supplied, all watches will be removed. @@ -10470,7 +11179,7 @@ declare function setWatch(func: any, pin: Pin, options: any): any; * @param {any} id - The id returned by a previous call to setWatch. **Only one argument is allowed.** * @url http://www.espruino.com/Reference#l__global_clearWatch */ -declare function clearWatch(...id: any[]): any; +declare function clearWatch(id: number): void; declare const global: { show: typeof show; @@ -10558,47 +11267,57 @@ declare const global: { } /** - * When Espruino is busy, set the pin specified here high. Set this to undefined to disable the feature. + * When Espruino is busy, set the pin specified here high. Set this to undefined to + * disable the feature. * * @param {any} pin * @url http://www.espruino.com/Reference#l__global_setBusyIndicator */ -declare function setBusyIndicator(pin: any): any; +declare function setBusyIndicator(pin: any): void; /** - * When Espruino is asleep, set the pin specified here low (when it's awake, set it high). Set this to undefined to disable the feature. + * When Espruino is asleep, set the pin specified here low (when it's awake, set it + * high). Set this to undefined to disable the feature. * Please see http://www.espruino.com/Power+Consumption for more details on this. * * @param {any} pin * @url http://www.espruino.com/Reference#l__global_setSleepIndicator */ -declare function setSleepIndicator(pin: any): any; +declare function setSleepIndicator(pin: any): void; /** - * Set whether we can enter deep sleep mode, which reduces power consumption to around 100uA. This only works on STM32 Espruino Boards (nRF52 boards sleep automatically). + * Set whether we can enter deep sleep mode, which reduces power consumption to + * around 100uA. This only works on STM32 Espruino Boards (nRF52 boards sleep + * automatically). * Please see http://www.espruino.com/Power+Consumption for more details on this. * * @param {boolean} sleep * @url http://www.espruino.com/Reference#l__global_setDeepSleep */ -declare function setDeepSleep(sleep: boolean): any; +declare function setDeepSleep(sleep: boolean): void; /** * Output debugging information - * Note: This is not included on boards with low amounts of flash memory, or the Espruino board. + * Note: This is not included on boards with low amounts of flash memory, or the + * Espruino board. * * @param {any} root - The symbol to output (optional). If nothing is specified, everything will be output * @url http://www.espruino.com/Reference#l__global_trace */ -declare function trace(root: any): any; +declare function trace(root: any): void; /** - * Output current interpreter state in a text form such that it can be copied to a new device - * Espruino keeps its current state in RAM (even if the function code is stored in Flash). When you type `dump()` it dumps the current state of code in RAM plus the hardware state, then if there's code saved in flash it writes "// Code saved with E.setBootCode" and dumps that too. - * **Note:** 'Internal' functions are currently not handled correctly. You will need to recreate these in the `onInit` function. + * Output current interpreter state in a text form such that it can be copied to a + * new device + * Espruino keeps its current state in RAM (even if the function code is stored in + * Flash). When you type `dump()` it dumps the current state of code in RAM plus + * the hardware state, then if there's code saved in flash it writes "// Code saved + * with E.setBootCode" and dumps that too. + * **Note:** 'Internal' functions are currently not handled correctly. You will + * need to recreate these in the `onInit` function. * @url http://www.espruino.com/Reference#l__global_dump */ -declare function dump(): any; +declare function dump(): void; /** * Restart and load the program out of flash - this has an effect similar to @@ -10607,81 +11326,95 @@ declare function dump(): any; * This command only executes when the Interpreter returns to the Idle state - for * instance ```a=1;load();a=2;``` will still leave 'a' as undefined (or what it was * set to in the saved program). - * Espruino will resume from where it was when you last typed `save()`. - * If you want code to be executed right after loading (for instance to initialise - * devices connected to Espruino), add an `init` event handler to `E` with - * `E.on('init', function() { ... your_code ... });`. This will then be automatically - * executed by Espruino every time it starts. - * **If you specify a filename in the argument then that file will be loaded - * from Storage after reset** in much the same way as calling `reset()` then `eval(require("Storage").read(filename))` + * Espruino will resume from where it was when you last typed `save()`. If you want + * code to be executed right after loading (for instance to initialise devices + * connected to Espruino), add an `init` event handler to `E` with `E.on('init', + * function() { ... your_code ... });`. This will then be automatically executed by + * Espruino every time it starts. + * **If you specify a filename in the argument then that file will be loaded from + * Storage after reset** in much the same way as calling `reset()` then + * `eval(require("Storage").read(filename))` * * @param {any} filename - optional: The name of a text JS file to load from Storage after reset * @url http://www.espruino.com/Reference#l__global_load */ -declare function load(filename: any): any; +declare function load(filename: any): void; /** * Save the state of the interpreter into flash (including the results of calling - * `setWatch`, `setInterval`, `pinMode`, and any listeners). The state will then be loaded automatically - * every time Espruino powers on or is hard-reset. To see what will get saved you can call `dump()`. - * **Note:** If you set up intervals/etc in `onInit()` and you have already called `onInit` - * before running `save()`, when Espruino resumes there will be two copies of your intervals - - * the ones from before the save, and the ones from after - which may cause you problems. - * For more information about this and other options for saving, please see - * the [Saving code on Espruino](https://www.espruino.com/Saving) page. + * `setWatch`, `setInterval`, `pinMode`, and any listeners). The state will then be + * loaded automatically every time Espruino powers on or is hard-reset. To see what + * will get saved you can call `dump()`. + * **Note:** If you set up intervals/etc in `onInit()` and you have already called + * `onInit` before running `save()`, when Espruino resumes there will be two copies + * of your intervals - the ones from before the save, and the ones from after - + * which may cause you problems. + * For more information about this and other options for saving, please see the + * [Saving code on Espruino](https://www.espruino.com/Saving) page. * This command only executes when the Interpreter returns to the Idle state - for * instance ```a=1;save();a=2;``` will save 'a' as 2. - * When Espruino powers on, it will resume from where it was when you typed `save()`. - * If you want code to be executed right after loading (for instance to initialise - * devices connected to Espruino), add a function called `onInit`, or add a `init` - * event handler to `E` with `E.on('init', function() { ... your_code ... });`. - * This will then be automatically executed by Espruino every time it starts. + * When Espruino powers on, it will resume from where it was when you typed + * `save()`. If you want code to be executed right after loading (for instance to + * initialise devices connected to Espruino), add a function called `onInit`, or + * add a `init` event handler to `E` with `E.on('init', function() { ... your_code + * ... });`. This will then be automatically executed by Espruino every time it + * starts. * In order to stop the program saved with this command being loaded automatically, - * check out [the Troubleshooting guide](https://www.espruino.com/Troubleshooting#espruino-stopped-working-after-i-typed-save-) + * check out [the Troubleshooting + * guide](https://www.espruino.com/Troubleshooting#espruino-stopped-working-after-i-typed-save-) * @url http://www.espruino.com/Reference#l__global_save */ -declare function save(): any; +declare function save(): void; /** - * Reset the interpreter - clear program memory in RAM, and do not load a saved program from flash. This does NOT reset the underlying hardware (which allows you to reset the device without it disconnecting from USB). - * This command only executes when the Interpreter returns to the Idle state - for instance ```a=1;reset();a=2;``` will still leave 'a' as undefined. + * Reset the interpreter - clear program memory in RAM, and do not load a saved + * program from flash. This does NOT reset the underlying hardware (which allows + * you to reset the device without it disconnecting from USB). + * This command only executes when the Interpreter returns to the Idle state - for + * instance ```a=1;reset();a=2;``` will still leave 'a' as undefined. * The safest way to do a full reset is to hit the reset button. - * If `reset()` is called with no arguments, it will reset the board's state in - * RAM but will not reset the state in flash. When next powered on (or when - * `load()` is called) the board will load the previously saved code. - * Calling `reset(true)` will cause *all saved code in flash memory to - * be cleared as well*. + * If `reset()` is called with no arguments, it will reset the board's state in RAM + * but will not reset the state in flash. When next powered on (or when `load()` is + * called) the board will load the previously saved code. + * Calling `reset(true)` will cause *all saved code in flash memory to be cleared + * as well*. * * @param {boolean} clearFlash - Remove saved code from flash as well * @url http://www.espruino.com/Reference#l__global_reset */ -declare function reset(clearFlash: boolean): any; +declare function reset(clearFlash: boolean): void; /** * Print the supplied string(s) to the console - * **Note:** If you're connected to a computer (not a wall adaptor) via USB but **you are not running a terminal app** then when you print data Espruino may pause execution and wait until the computer requests the data it is trying to print. + * **Note:** If you're connected to a computer (not a wall adaptor) via USB but + * **you are not running a terminal app** then when you print data Espruino may + * pause execution and wait until the computer requests the data it is trying to + * print. * * @param {any} text * @url http://www.espruino.com/Reference#l__global_print */ -declare function print(...text: any[]): any; +declare function print(...text: any[]): void; /** * Fill the console with the contents of the given function, so you can edit it. - * NOTE: This is a convenience function - it will not edit 'inner functions'. For that, you must edit the 'outer function' and re-execute it. + * NOTE: This is a convenience function - it will not edit 'inner functions'. For + * that, you must edit the 'outer function' and re-execute it. * * @param {any} funcName - The name of the function to edit (either a string or just the unquoted name) * @url http://www.espruino.com/Reference#l__global_edit */ -declare function edit(funcName: any): any; +declare function edit(funcName: any): void; /** - * Should Espruino echo what you type back to you? true = yes (Default), false = no. When echo is off, the result of executing a command is not returned. Instead, you must use 'print' to send output. + * Should Espruino echo what you type back to you? true = yes (Default), false = + * no. When echo is off, the result of executing a command is not returned. + * Instead, you must use 'print' to send output. * * @param {boolean} echoOn * @url http://www.espruino.com/Reference#l__global_echo */ -declare function echo(echoOn: boolean): any; +declare function echo(echoOn: boolean): void; /** * Return the current system time in Seconds (as a floating point number) @@ -10691,12 +11424,11 @@ declare function echo(echoOn: boolean): any; declare function getTime(): number; /** - * Set the current system time in seconds (`time` can be a floating - * point value). - * This is used with `getTime`, the time reported from `setWatch`, as - * well as when using `new Date()`. - * `Date.prototype.getTime()` reports the time in milliseconds, so - * you can set the time to a `Date` object using: + * Set the current system time in seconds (`time` can be a floating point value). + * This is used with `getTime`, the time reported from `setWatch`, as well as when + * using `new Date()`. + * `Date.prototype.getTime()` reports the time in milliseconds, so you can set the + * time to a `Date` object using: * ``` * setTime((new Date("Tue, 19 Feb 2019 10:57")).getTime()/1000) * ``` @@ -10705,7 +11437,7 @@ declare function getTime(): number; * @param {number} time * @url http://www.espruino.com/Reference#l__global_setTime */ -declare function setTime(time: number): any; +declare function setTime(time: number): void; /** * Get the serial number of this board @@ -10715,7 +11447,8 @@ declare function setTime(time: number): any; declare function getSerial(): any; /** - * Call the function (or evaluate the string) specified REPEATEDLY after the timeout in milliseconds. + * Call the function (or evaluate the string) specified REPEATEDLY after the + * timeout in milliseconds. * For instance: * ``` * setInterval(function () { @@ -10725,16 +11458,20 @@ declare function getSerial(): any; * setInterval('console.log("Hello World");', 1000); * // both print 'Hello World' every second * ``` - * You can also specify extra arguments that will be sent to the function when it is executed. For example: + * You can also specify extra arguments that will be sent to the function when it + * is executed. For example: * ``` * setInterval(function (a,b) { * console.log(a+" "+b); * }, 1000, "Hello", "World"); * // prints 'Hello World' every second * ``` - * If you want to stop your function from being called, pass the number that - * was returned by `setInterval` into the `clearInterval` function. - * **Note:** If `setDeepSleep(true)` has been called and the interval is greater than 5 seconds, Espruino may execute the interval up to 1 second late. This is because Espruino can only wake from deep sleep every second - and waking early would cause Espruino to waste power while it waited for the correct time. + * If you want to stop your function from being called, pass the number that was + * returned by `setInterval` into the `clearInterval` function. + * **Note:** If `setDeepSleep(true)` has been called and the interval is greater + * than 5 seconds, Espruino may execute the interval up to 1 second late. This is + * because Espruino can only wake from deep sleep every second - and waking early + * would cause Espruino to waste power while it waited for the correct time. * * @param {any} function - A Function or String to be executed * @param {number} timeout - The time between calls to the function (max 3153600000000 = 100 years @@ -10745,7 +11482,8 @@ declare function getSerial(): any; declare function setInterval(func: any, timeout: number, ...args: any[]): any; /** - * Call the function (or evaluate the string) specified ONCE after the timeout in milliseconds. + * Call the function (or evaluate the string) specified ONCE after the timeout in + * milliseconds. * For instance: * ``` * setTimeout(function () { @@ -10755,16 +11493,20 @@ declare function setInterval(func: any, timeout: number, ...args: any[]): any; * setTimeout('console.log("Hello World");', 1000); * // both print 'Hello World' after a second * ``` - * You can also specify extra arguments that will be sent to the function when it is executed. For example: + * You can also specify extra arguments that will be sent to the function when it + * is executed. For example: * ``` * setTimeout(function (a,b) { * console.log(a+" "+b); * }, 1000, "Hello", "World"); * // prints 'Hello World' after 1 second * ``` - * If you want to stop the function from being called, pass the number that - * was returned by `setTimeout` into the `clearTimeout` function. - * **Note:** If `setDeepSleep(true)` has been called and the interval is greater than 5 seconds, Espruino may execute the interval up to 1 second late. This is because Espruino can only wake from deep sleep every second - and waking early would cause Espruino to waste power while it waited for the correct time. + * If you want to stop the function from being called, pass the number that was + * returned by `setTimeout` into the `clearTimeout` function. + * **Note:** If `setDeepSleep(true)` has been called and the interval is greater + * than 5 seconds, Espruino may execute the interval up to 1 second late. This is + * because Espruino can only wake from deep sleep every second - and waking early + * would cause Espruino to waste power while it waited for the correct time. * * @param {any} function - A Function or String to be executed * @param {number} timeout - The time until the function will be executed (max 3153600000000 = 100 years @@ -10784,7 +11526,7 @@ declare function setTimeout(func: any, timeout: number, ...args: any[]): any; * @param {any} id - The id returned by a previous call to setInterval. **Only one argument is allowed.** * @url http://www.espruino.com/Reference#l__global_clearInterval */ -declare function clearInterval(...id: any[]): any; +declare function clearInterval(...id: any[]): void; /** * Clear the Timeout that was created with `setTimeout`, for example: @@ -10796,21 +11538,21 @@ declare function clearInterval(...id: any[]): any; * @param {any} id - The id returned by a previous call to setTimeout. **Only one argument is allowed.** * @url http://www.espruino.com/Reference#l__global_clearTimeout */ -declare function clearTimeout(...id: any[]): any; +declare function clearTimeout(...id: any[]): void; /** * Change the Interval on a callback created with `setInterval`, for example: * ```var id = setInterval(function () { print('foo'); }, 1000); // every second``` * ```changeInterval(id, 1500); // now runs every 1.5 seconds``` * This takes effect immediately and resets the timeout, so in the example above, - * regardless of when you call `changeInterval`, the next interval will occur 1500ms - * after it. + * regardless of when you call `changeInterval`, the next interval will occur + * 1500ms after it. * * @param {any} id - The id returned by a previous call to setInterval * @param {number} time - The new time period in ms * @url http://www.espruino.com/Reference#l__global_changeInterval */ -declare function changeInterval(id: any, time: number): any; +declare function changeInterval(id: any, time: number): void; // LIBRARIES @@ -10830,16 +11572,24 @@ type Libraries = { } /** - * This library handles interfacing with a FAT32 filesystem on an SD card. The API is designed to be similar to node.js's - However Espruino does not currently support asynchronous file IO, so the functions behave like node.js's xxxxSync functions. Versions of the functions with 'Sync' after them are also provided for compatibility. - * To use this, you must type ```var fs = require('fs')``` to get access to the library - * See [the page on File IO](http://www.espruino.com/File+IO) for more information, and for examples on wiring up an SD card if your device doesn't come with one. - * **Note:** If you want to remove an SD card after you have started using it, you *must* call `E.unmountSD()` or you may cause damage to the card. + * This library handles interfacing with a FAT32 filesystem on an SD card. The API + * is designed to be similar to node.js's - However Espruino does not currently + * support asynchronous file IO, so the functions behave like node.js's xxxxSync + * functions. Versions of the functions with 'Sync' after them are also provided + * for compatibility. + * To use this, you must type ```var fs = require('fs')``` to get access to the + * library + * See [the page on File IO](http://www.espruino.com/File+IO) for more information, + * and for examples on wiring up an SD card if your device doesn't come with one. + * **Note:** If you want to remove an SD card after you have started using it, you + * *must* call `E.unmountSD()` or you may cause damage to the card. * @url http://www.espruino.com/Reference#fs */ fs: { /** * List all files in the supplied directory, returning them as an array of strings. - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The path of the directory to list. If it is not supplied, '' is assumed, which will list the root directory * @returns {any} An array of filename strings (or undefined if the directory couldn't be listed) @@ -10858,7 +11608,8 @@ type Libraries = { /** * Write the data to the given file - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The path of the file to write * @param {any} data - The data to write to the file @@ -10879,7 +11630,8 @@ type Libraries = { /** * Append the data to the given file, created a new file if it doesn't exist - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The path of the file to write * @param {any} data - The data to write to the file @@ -10900,7 +11652,8 @@ type Libraries = { /** * Read all data from a file and return as a string - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The path of the file to read * @returns {any} A string containing the contents of the file (or undefined if the file doesn't exist) @@ -10910,7 +11663,8 @@ type Libraries = { /** * Read all data from a file and return as a string. - * **Note:** The size of files you can load using this method is limited by the amount of available RAM. To read files a bit at a time, see the `File` class. + * **Note:** The size of files you can load using this method is limited by the + * amount of available RAM. To read files a bit at a time, see the `File` class. * * @param {any} path - The path of the file to read * @returns {any} A string containing the contents of the file (or undefined if the file doesn't exist) @@ -10920,7 +11674,8 @@ type Libraries = { /** * Delete the given file - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The path of the file to delete * @returns {boolean} True on success, or false on failure @@ -10940,8 +11695,7 @@ type Libraries = { /** * Return information on the given file. This returns an object with the following * fields: - * size: size in bytes - * dir: a boolean specifying if the file is a directory or not + * size: size in bytes dir: a boolean specifying if the file is a directory or not * mtime: A Date structure specifying the time the file was last modified * * @param {any} path - The path of the file to get information on @@ -10952,7 +11706,8 @@ type Libraries = { /** * Create the directory - * NOTE: Espruino does not yet support Async file IO, so this function behaves like the 'Sync' version. + * NOTE: Espruino does not yet support Async file IO, so this function behaves like + * the 'Sync' version. * * @param {any} path - The name of the directory to create * @returns {boolean} True on success, or false on failure @@ -10980,12 +11735,14 @@ type Libraries = { * end : call the 'end' function on the destination when the source is finished * @url http://www.espruino.com/Reference#l_fs_pipe */ - pipe(source: any, destination: any, options: any): any; + pipe(source: any, destination: any, options: any): void; } /** * Cryptographic functions - * **Note:** This library is currently only included in builds for boards where there is space. For other boards there is `crypto.js` which implements SHA1 in JS. + * **Note:** This library is currently only included in builds for boards where + * there is space. For other boards there is `crypto.js` which implements SHA1 in + * JS. * @url http://www.espruino.com/Reference#crypto */ crypto: { @@ -10998,9 +11755,9 @@ type Libraries = { /** * Performs a SHA1 hash and returns the result as a 20 byte ArrayBuffer. - * **Note:** On some boards (currently only Espruino Original) there - * isn't space for a fully unrolled SHA1 implementation so a slower - * all-JS implementation is used instead. + * **Note:** On some boards (currently only Espruino Original) there isn't space + * for a fully unrolled SHA1 implementation so a slower all-JS implementation is + * used instead. * * @param {any} message - The message to apply the hash to * @returns {any} Returns a 20 byte ArrayBuffer @@ -11062,7 +11819,8 @@ type Libraries = { */ NetworkJS: { /** - * Initialise the network using the callbacks given and return the first argument. For instance: + * Initialise the network using the callbacks given and return the first argument. + * For instance: * ``` * require("NetworkJS").create({ * create : function(host, port, socketType, options) { @@ -11090,8 +11848,9 @@ type Libraries = { * } * }); * ``` - * `socketType` is an integer - 2 for UDP, or see SocketType in https://github.com/espruino/Espruino/blob/master/libs/network/network.h - * for more information. + * `socketType` is an integer - 2 for UDP, or see SocketType in + * https://github.com/espruino/Espruino/blob/master/libs/network/network.h for more + * information. * * @param {any} obj - An object containing functions to access the network device * @returns {any} The object passed in @@ -11101,9 +11860,9 @@ type Libraries = { } /** - * This library implements a telnet console for the Espruino interpreter. It requires a network - * connection, e.g. Wifi, and **currently only functions on the ESP8266 and on Linux **. It uses - * port 23 on the ESP8266 and port 2323 on Linux. + * This library implements a telnet console for the Espruino interpreter. It + * requires a network connection, e.g. Wifi, and **currently only functions on the + * ESP8266 and on Linux **. It uses port 23 on the ESP8266 and port 2323 on Linux. * **Note:** To enable on Linux, run `./espruino --telnet` * @url http://www.espruino.com/Reference#TelnetServer */ @@ -11113,19 +11872,23 @@ type Libraries = { * @param {any} options - Options controlling the telnet console server `{ mode : 'on|off'}` * @url http://www.espruino.com/Reference#l_TelnetServer_setOptions */ - setOptions(options: any): any; + setOptions(options: any): void; } /** * This library allows you to create TCPIP servers and clients * In order to use this, you will need an extra module to get network connectivity. - * This is designed to be a cut-down version of the [node.js library](http://nodejs.org/api/net.html). Please see the [Internet](/Internet) page for more information on how to use it. + * This is designed to be a cut-down version of the [node.js + * library](http://nodejs.org/api/net.html). Please see the [Internet](/Internet) + * page for more information on how to use it. * @url http://www.espruino.com/Reference#net */ net: { /** * Create a Server - * When a request to the server is made, the callback is called. In the callback you can use the methods on the connection to send data. You can also add `connection.on('data',function() { ... })` to listen for received data + * When a request to the server is made, the callback is called. In the callback + * you can use the methods on the connection to send data. You can also add + * `connection.on('data',function() { ... })` to listen for received data * * @param {any} callback - A `function(connection)` that will be called when a connection is made * @returns {any} Returns a new Server Object @@ -11147,7 +11910,9 @@ type Libraries = { /** * This library allows you to create UDP/DATAGRAM servers and clients * In order to use this, you will need an extra module to get network connectivity. - * This is designed to be a cut-down version of the [node.js library](http://nodejs.org/api/dgram.html). Please see the [Internet](/Internet) page for more information on how to use it. + * This is designed to be a cut-down version of the [node.js + * library](http://nodejs.org/api/dgram.html). Please see the [Internet](/Internet) + * page for more information on how to use it. * @url http://www.espruino.com/Reference#dgram */ dgram: { @@ -11165,13 +11930,16 @@ type Libraries = { /** * This library allows you to create TCPIP servers and clients using TLS encryption * In order to use this, you will need an extra module to get network connectivity. - * This is designed to be a cut-down version of the [node.js library](http://nodejs.org/api/tls.html). Please see the [Internet](/Internet) page for more information on how to use it. + * This is designed to be a cut-down version of the [node.js + * library](http://nodejs.org/api/tls.html). Please see the [Internet](/Internet) + * page for more information on how to use it. * @url http://www.espruino.com/Reference#tls */ tls: { /** * Create a socket connection using TLS - * Options can have `ca`, `key` and `cert` fields, which should be the decoded content of the certificate. + * Options can have `ca`, `key` and `cert` fields, which should be the decoded + * content of the certificate. * ``` * var options = url.parse("localhost:1234"); * options.key = atob("MIIJKQ ... OZs08C"); @@ -11179,10 +11947,14 @@ type Libraries = { * options.ca = atob("MIIFgDCC ... GosQML4sc="); * require("tls").connect(options, ... ); * ``` - * If you have the certificates as `.pem` files, you need to load these files, take the information between the lines beginning with `----`, remove the newlines from it so you have raw base64, and then feed it into `atob` as above. + * If you have the certificates as `.pem` files, you need to load these files, take + * the information between the lines beginning with `----`, remove the newlines + * from it so you have raw base64, and then feed it into `atob` as above. * You can also: - * * Just specify the filename (<=100 characters) and it will be loaded and parsed if you have an SD card connected. For instance `options.key = "key.pem";` - * * Specify a function, which will be called to retrieve the data. For instance `options.key = function() { eeprom.load_my_info(); }; + * * Just specify the filename (<=100 characters) and it will be loaded and parsed + * if you have an SD card connected. For instance `options.key = "key.pem";` + * * Specify a function, which will be called to retrieve the data. For instance + * `options.key = function() { eeprom.load_my_info(); }; * For more information about generating and using certificates, see: * https://engineering.circle.com/https-authorized-certs-with-node-js/ * (You'll need to use 2048 bit certificates as opposed to 4096 bit shown above) @@ -11229,33 +12001,37 @@ type Libraries = { } /** - * The Wifi library is designed to control the Wifi interface. It supports functionality - * such as connecting to wifi networks, getting network information, starting an access - * point, etc. + * The Wifi library is designed to control the Wifi interface. It supports + * functionality such as connecting to wifi networks, getting network information, + * starting an access point, etc. * It is available on these devices: * * [Espruino WiFi](http://www.espruino.com/WiFi#using-wifi) * * [ESP8266](http://www.espruino.com/EspruinoESP8266) * * [ESP32](http://www.espruino.com/ESP32) - * **Certain features may or may not be implemented on your device** however - * we have documented what is available and what isn't. + * **Certain features may or may not be implemented on your device** however we + * have documented what is available and what isn't. * If you're not using one of the devices above, a separate WiFi library is * provided. For instance: - * * An [ESP8266 connected to an Espruino board](http://www.espruino.com/ESP8266#software) + * * An [ESP8266 connected to an Espruino + * board](http://www.espruino.com/ESP8266#software) * * An [CC3000 WiFi Module](http://www.espruino.com/CC3000) - * [Other ways of connecting to the net](http://www.espruino.com/Internet#related-pages) such - * as GSM, Ethernet and LTE have their own libraries. + * [Other ways of connecting to the + * net](http://www.espruino.com/Internet#related-pages) such as GSM, Ethernet and + * LTE have their own libraries. * You can use the WiFi library as follows: * ``` * var wifi = require("Wifi"); * wifi.connect("my-ssid", {password:"my-pwd"}, function(ap){ console.log("connected:", ap); }); * ``` - * On ESP32/ESP8266 if you want the connection to happen automatically at boot, add `wifi.save();`. - * On other platforms, place `wifi.connect` in a function called `onInit`. + * On ESP32/ESP8266 if you want the connection to happen automatically at boot, add + * `wifi.save();`. On other platforms, place `wifi.connect` in a function called + * `onInit`. * @url http://www.espruino.com/Reference#Wifi */ Wifi: { /** - * The 'associated' event is called when an association with an access point has succeeded, i.e., a connection to the AP's network has been established. + * The 'associated' event is called when an association with an access point has + * succeeded, i.e., a connection to the AP's network has been established. * On ESP32/ESP8266 there is a `details` parameter which includes: * * ssid - The SSID of the access point to which the association was established * * mac - The BSSID/mac address of the access point @@ -11268,7 +12044,8 @@ type Libraries = { on(event: "associated", callback: (details: any) => void): void; /** - * The 'disconnected' event is called when an association with an access point has been lost. + * The 'disconnected' event is called when an association with an access point has + * been lost. * On ESP32/ESP8266 there is a `details` parameter which includes: * * ssid - The SSID of the access point from which the association was lost * * mac - The BSSID/mac address of the access point @@ -11281,8 +12058,8 @@ type Libraries = { on(event: "disconnected", callback: (details: any) => void): void; /** - * The 'auth_change' event is called when the authentication mode with the associated access point changes. - * The details include: + * The 'auth_change' event is called when the authentication mode with the + * associated access point changes. The details include: * * oldMode - The old auth mode (string: open, wep, wpa, wpa2, wpa_wpa2) * * newMode - The new auth mode (string: open, wep, wpa, wpa2, wpa_wpa2) * @param {string} event - The event to listen to. @@ -11293,7 +12070,8 @@ type Libraries = { on(event: "auth_change", callback: (details: any) => void): void; /** - * The 'dhcp_timeout' event is called when a DHCP request to the connected access point fails and thus no IP address could be acquired (or renewed). + * The 'dhcp_timeout' event is called when a DHCP request to the connected access + * point fails and thus no IP address could be acquired (or renewed). * @param {string} event - The event to listen to. * @param {() => void} callback - A function that is executed when the event occurs. * @url http://www.espruino.com/Reference#l_Wifi_dhcp_timeout @@ -11301,7 +12079,11 @@ type Libraries = { on(event: "dhcp_timeout", callback: () => void): void; /** - * The 'connected' event is called when the connection with an access point is ready for traffic. In the case of a dynamic IP address configuration this is when an IP address is obtained, in the case of static IP address allocation this happens when an association is formed (in that case the 'associated' and 'connected' events are fired in rapid succession). + * The 'connected' event is called when the connection with an access point is + * ready for traffic. In the case of a dynamic IP address configuration this is + * when an IP address is obtained, in the case of static IP address allocation this + * happens when an association is formed (in that case the 'associated' and + * 'connected' events are fired in rapid succession). * On ESP32/ESP8266 there is a `details` parameter which includes: * * ip - The IP address obtained as string * * netmask - The network's IP range mask as string @@ -11314,8 +12096,8 @@ type Libraries = { on(event: "connected", callback: (details: any) => void): void; /** - * The 'sta_joined' event is called when a station establishes an association (i.e. connects) with the esp8266's access point. - * The details include: + * The 'sta_joined' event is called when a station establishes an association (i.e. + * connects) with the esp8266's access point. The details include: * * mac - The MAC address of the station in string format (00:00:00:00:00:00) * @param {string} event - The event to listen to. * @param {(details: any) => void} callback - A function that is executed when the event occurs. Its arguments are: @@ -11325,8 +12107,8 @@ type Libraries = { on(event: "sta_joined", callback: (details: any) => void): void; /** - * The 'sta_left' event is called when a station disconnects from the esp8266's access point (or its association times out?). - * The details include: + * The 'sta_left' event is called when a station disconnects from the esp8266's + * access point (or its association times out?). The details include: * * mac - The MAC address of the station in string format (00:00:00:00:00:00) * @param {string} event - The event to listen to. * @param {(details: any) => void} callback - A function that is executed when the event occurs. Its arguments are: @@ -11336,8 +12118,8 @@ type Libraries = { on(event: "sta_left", callback: (details: any) => void): void; /** - * The 'probe_recv' event is called when a probe request is received from some station by the esp8266's access point. - * The details include: + * The 'probe_recv' event is called when a probe request is received from some + * station by the esp8266's access point. The details include: * * mac - The MAC address of the station in string format (00:00:00:00:00:00) * * rssi - The signal strength in dB of the probe request * @param {string} event - The event to listen to. @@ -11348,43 +12130,65 @@ type Libraries = { on(event: "probe_recv", callback: (details: any) => void): void; /** - * Disconnect the wifi station from an access point and disable the station mode. It is OK to call `disconnect` to turn off station mode even if no connection exists (for example, connection attempts may be failing). Station mode can be re-enabled by calling `connect` or `scan`. + * Disconnect the wifi station from an access point and disable the station mode. + * It is OK to call `disconnect` to turn off station mode even if no connection + * exists (for example, connection attempts may be failing). Station mode can be + * re-enabled by calling `connect` or `scan`. * * @param {any} callback - An optional `callback()` function to be called back on disconnection. The callback function receives no argument. * @url http://www.espruino.com/Reference#l_Wifi_disconnect */ - disconnect(callback: any): any; + disconnect(callback: any): void; /** - * Stop being an access point and disable the AP operation mode. AP mode can be re-enabled by calling `startAP`. + * Stop being an access point and disable the AP operation mode. AP mode can be + * re-enabled by calling `startAP`. * * @param {any} callback - An optional `callback()` function to be called back on successful stop. The callback function receives no argument. * @url http://www.espruino.com/Reference#l_Wifi_stopAP */ - stopAP(callback: any): any; + stopAP(callback: any): void; /** - * Connect to an access point as a station. If there is an existing connection to an AP it is first disconnected if the SSID or password are different from those passed as parameters. Put differently, if the passed SSID and password are identical to the currently connected AP then nothing is changed. - * When the connection attempt completes the callback function is invoked with one `err` parameter, which is NULL if there is no error and a string message if there is an error. If DHCP is enabled the callback occurs once an IP addres has been obtained, if a static IP is set the callback occurs once the AP's network has been joined. The callback is also invoked if a connection already exists and does not need to be changed. + * Connect to an access point as a station. If there is an existing connection to + * an AP it is first disconnected if the SSID or password are different from those + * passed as parameters. Put differently, if the passed SSID and password are + * identical to the currently connected AP then nothing is changed. When the + * connection attempt completes the callback function is invoked with one `err` + * parameter, which is NULL if there is no error and a string message if there is + * an error. If DHCP is enabled the callback occurs once an IP addres has been + * obtained, if a static IP is set the callback occurs once the AP's network has + * been joined. The callback is also invoked if a connection already exists and + * does not need to be changed. * The options properties may contain: * * `password` - Password string to be used to access the network. - * * `dnsServers` (array of String) - An array of up to two DNS servers in dotted decimal format string. - * * `channel` - Wifi channel of the access point (integer, typ 0..14, 0 means any channel), only on ESP8266. - * * `bssid` - Mac address of the access point (string, type "00:00:00:00:00:00"), only on ESP8266. + * * `dnsServers` (array of String) - An array of up to two DNS servers in dotted + * decimal format string. + * * `channel` - Wifi channel of the access point (integer, typ 0..14, 0 means any + * channel), only on ESP8266. + * * `bssid` - Mac address of the access point (string, type "00:00:00:00:00:00"), + * only on ESP8266. * Notes: - * * the options should include the ability to set a static IP and associated netmask and gateway, this is a future enhancement. - * * the only error reported in the callback is "Bad password", all other errors (such as access point not found or DHCP timeout) just cause connection retries. If the reporting of such temporary errors is desired, the caller must use its own timeout and the `getDetails().status` field. - * * the `connect` call automatically enabled station mode, it can be disabled again by calling `disconnect`. + * * the options should include the ability to set a static IP and associated + * netmask and gateway, this is a future enhancement. + * * the only error reported in the callback is "Bad password", all other errors + * (such as access point not found or DHCP timeout) just cause connection + * retries. If the reporting of such temporary errors is desired, the caller must + * use its own timeout and the `getDetails().status` field. + * * the `connect` call automatically enabled station mode, it can be disabled + * again by calling `disconnect`. * * @param {any} ssid - The access point network id. * @param {any} options - Connection options (optional). * @param {any} callback - A `callback(err)` function to be called back on completion. `err` is null on success, or contains an error string on failure. * @url http://www.espruino.com/Reference#l_Wifi_connect */ - connect(ssid: any, options: any, callback: any): any; + connect(ssid: any, options: any, callback: any): void; /** - * Perform a scan for access points. This will enable the station mode if it is not currently enabled. Once the scan is complete the callback function is called with an array of APs found, each AP is an object with: + * Perform a scan for access points. This will enable the station mode if it is not + * currently enabled. Once the scan is complete the callback function is called + * with an array of APs found, each AP is an object with: * * `ssid`: SSID string. * * `mac`: access point MAC address in 00:00:00:00:00:00 format. * * `authMode`: `open`, `wep`, `wpa`, `wpa2`, or `wpa_wpa2`. @@ -11392,41 +12196,63 @@ type Libraries = { * * `hidden`: true if the SSID is hidden (ESP32/ESP8266 only) * * `rssi`: signal strength in dB in the range -110..0. * Notes: - * * in order to perform the scan the station mode is turned on and remains on, use Wifi.disconnect() to turn it off again, if desired. + * * in order to perform the scan the station mode is turned on and remains on, use + * Wifi.disconnect() to turn it off again, if desired. * * only one scan can be in progress at a time. * * @param {any} callback - A `callback(err, ap_list)` function to be called back on completion. `err==null` and `ap_list` is an array on success, or `err` is an error string and `ap_list` is undefined on failure. * @url http://www.espruino.com/Reference#l_Wifi_scan */ - scan(callback: any): any; + scan(callback: any): void; /** - * Create a WiFi access point allowing stations to connect. If the password is NULL or an empty string the access point is open, otherwise it is encrypted. - * The callback function is invoked once the access point is set-up and receives one `err` argument, which is NULL on success and contains an error message string otherwise. + * Create a WiFi access point allowing stations to connect. If the password is NULL + * or an empty string the access point is open, otherwise it is encrypted. The + * callback function is invoked once the access point is set-up and receives one + * `err` argument, which is NULL on success and contains an error message string + * otherwise. * The `options` object can contain the following properties. - * * `authMode` - The authentication mode to use. Can be one of "open", "wpa2", "wpa", "wpa_wpa2". The default is open (but open access points are not recommended). + * * `authMode` - The authentication mode to use. Can be one of "open", "wpa2", + * "wpa", "wpa_wpa2". The default is open (but open access points are not + * recommended). * * `password` - The password for connecting stations if authMode is not open. - * * `channel` - The channel to be used for the access point in the range 1..13. If the device is also connected to an access point as a station then that access point determines the channel. - * * `hidden` - The flag if visible or not (0:visible, 1:hidden), default is visible. + * * `channel` - The channel to be used for the access point in the range 1..13. If + * the device is also connected to an access point as a station then that access + * point determines the channel. + * * `hidden` - The flag if visible or not (0:visible, 1:hidden), default is + * visible. * Notes: - * * the options should include the ability to set the AP IP and associated netmask, this is a future enhancement. - * * the `startAP` call automatically enables AP mode. It can be disabled again by calling `stopAP`. + * * the options should include the ability to set the AP IP and associated + * netmask, this is a future enhancement. + * * the `startAP` call automatically enables AP mode. It can be disabled again by + * calling `stopAP`. * * @param {any} ssid - The network id. * @param {any} options - Configuration options (optional). * @param {any} callback - Optional `callback(err)` function to be called when the AP is successfully started. `err==null` on success, or an error string on failure. * @url http://www.espruino.com/Reference#l_Wifi_startAP */ - startAP(ssid: any, options: any, callback: any): any; + startAP(ssid: any, options: any, callback: any): void; /** - * Retrieve the current overall WiFi configuration. This call provides general information that pertains to both station and access point modes. The getDetails and getAPDetails calls provide more in-depth information about the station and access point configurations, respectively. The status object has the following properties: + * Retrieve the current overall WiFi configuration. This call provides general + * information that pertains to both station and access point modes. The getDetails + * and getAPDetails calls provide more in-depth information about the station and + * access point configurations, respectively. The status object has the following + * properties: * * `station` - Status of the wifi station: `off`, `connecting`, ... * * `ap` - Status of the wifi access point: `disabled`, `enabled`. * * `mode` - The current operation mode: `off`, `sta`, `ap`, `sta+ap`. - * * `phy` - Modulation standard configured: `11b`, `11g`, `11n` (the esp8266 docs are not very clear, but it is assumed that 11n means b/g/n). This setting limits the modulations that the radio will use, it does not indicate the current modulation used with a specific access point. - * * `powersave` - Power saving mode: `none` (radio is on all the time), `ps-poll` (radio is off between beacons as determined by the access point's DTIM setting). Note that in 'ap' and 'sta+ap' modes the radio is always on, i.e., no power saving is possible. - * * `savedMode` - The saved operation mode which will be applied at boot time: `off`, `sta`, `ap`, `sta+ap`. + * * `phy` - Modulation standard configured: `11b`, `11g`, `11n` (the esp8266 docs + * are not very clear, but it is assumed that 11n means b/g/n). This setting + * limits the modulations that the radio will use, it does not indicate the + * current modulation used with a specific access point. + * * `powersave` - Power saving mode: `none` (radio is on all the time), `ps-poll` + * (radio is off between beacons as determined by the access point's DTIM + * setting). Note that in 'ap' and 'sta+ap' modes the radio is always on, i.e., + * no power saving is possible. + * * `savedMode` - The saved operation mode which will be applied at boot time: + * `off`, `sta`, `ap`, `sta+ap`. * * @param {any} callback - Optional `callback(status)` function to be called back with the current Wifi status, i.e. the same object as returned directly. * @returns {any} An object representing the current WiFi status, if available immediately. @@ -11435,24 +12261,40 @@ type Libraries = { getStatus(callback: any): any; /** - * Sets a number of global wifi configuration settings. All parameters are optional and which are passed determines which settings are updated. - * The settings available are: - * * `phy` - Modulation standard to allow: `11b`, `11g`, `11n` (the esp8266 docs are not very clear, but it is assumed that 11n means b/g/n). - * * `powersave` - Power saving mode: `none` (radio is on all the time), `ps-poll` (radio is off between beacons as determined by the access point's DTIM setting). Note that in 'ap' and 'sta+ap' modes the radio is always on, i.e., no power saving is possible. - * Note: esp8266 SDK programmers may be missing an "opmode" option to set the sta/ap/sta+ap operation mode. Please use connect/scan/disconnect/startAP/stopAP, which all set the esp8266 opmode indirectly. + * Sets a number of global wifi configuration settings. All parameters are optional + * and which are passed determines which settings are updated. The settings + * available are: + * * `phy` - Modulation standard to allow: `11b`, `11g`, `11n` (the esp8266 docs + * are not very clear, but it is assumed that 11n means b/g/n). + * * `powersave` - Power saving mode: `none` (radio is on all the time), `ps-poll` + * (radio is off between beacons as determined by the access point's DTIM + * setting). Note that in 'ap' and 'sta+ap' modes the radio is always on, i.e., + * no power saving is possible. + * Note: esp8266 SDK programmers may be missing an "opmode" option to set the + * sta/ap/sta+ap operation mode. Please use connect/scan/disconnect/startAP/stopAP, + * which all set the esp8266 opmode indirectly. * * @param {any} settings - An object with the configuration settings to change. * @url http://www.espruino.com/Reference#l_Wifi_setConfig */ - setConfig(settings: any): any; + setConfig(settings: any): void; /** - * Retrieve the wifi station configuration and status details. The details object has the following properties: - * * `status` - Details about the wifi station connection, one of `off`, `connecting`, `wrong_password`, `no_ap_found`, `connect_fail`, or `connected`. The off, bad_password and connected states are stable, the other states are transient. The connecting state will either result in connected or one of the error states (bad_password, no_ap_found, connect_fail) and the no_ap_found and connect_fail states will result in a reconnection attempt after some interval. - * * `rssi` - signal strength of the connected access point in dB, typically in the range -110 to 0, with anything greater than -30 being an excessively strong signal. + * Retrieve the wifi station configuration and status details. The details object + * has the following properties: + * * `status` - Details about the wifi station connection, one of `off`, + * `connecting`, `wrong_password`, `no_ap_found`, `connect_fail`, or `connected`. + * The off, bad_password and connected states are stable, the other states are + * transient. The connecting state will either result in connected or one of the + * error states (bad_password, no_ap_found, connect_fail) and the no_ap_found and + * connect_fail states will result in a reconnection attempt after some interval. + * * `rssi` - signal strength of the connected access point in dB, typically in the + * range -110 to 0, with anything greater than -30 being an excessively strong + * signal. * * `ssid` - SSID of the access point. * * `password` - the password used to connect to the access point. - * * `authMode` - the authentication used: `open`, `wpa`, `wpa2`, `wpa_wpa2` (not currently supported). + * * `authMode` - the authentication used: `open`, `wpa`, `wpa2`, `wpa_wpa2` (not + * currently supported). * * `savedSsid` - the SSID to connect to automatically at boot time, null if none. * * @param {any} callback - An optional `callback(details)` function to be called back with the wifi details, i.e. the same object as returned directly. @@ -11462,15 +12304,20 @@ type Libraries = { getDetails(callback: any): any; /** - * Retrieve the current access point configuration and status. The details object has the following properties: + * Retrieve the current access point configuration and status. The details object + * has the following properties: * * `status` - Current access point status: `enabled` or `disabled` - * * `stations` - an array of the stations connected to the access point. This array may be empty. Each entry in the array is an object describing the station which, at a minimum contains `ip` being the IP address of the station. + * * `stations` - an array of the stations connected to the access point. This + * array may be empty. Each entry in the array is an object describing the + * station which, at a minimum contains `ip` being the IP address of the station. * * `ssid` - SSID to broadcast. * * `password` - Password for authentication. - * * `authMode` - the authentication required of stations: `open`, `wpa`, `wpa2`, `wpa_wpa2`. + * * `authMode` - the authentication required of stations: `open`, `wpa`, `wpa2`, + * `wpa_wpa2`. * * `hidden` - True if the SSID is hidden, false otherwise. * * `maxConn` - Max number of station connections supported. - * * `savedSsid` - the SSID to broadcast automatically at boot time, null if the access point is to be disabled at boot. + * * `savedSsid` - the SSID to broadcast automatically at boot time, null if the + * access point is to be disabled at boot. * * @param {any} callback - An optional `callback(details)` function to be called back with the current access point details, i.e. the same object as returned directly. * @returns {any} An object representing the current access point details, if available immediately. @@ -11479,8 +12326,12 @@ type Libraries = { getAPDetails(callback: any): any; /** - * On boards where this is not available, just issue the `connect` commands you need to run at startup from an `onInit` function. - * Save the current wifi configuration (station and access point) to flash and automatically apply this configuration at boot time, unless `what=="clear"`, in which case the saved configuration is cleared such that wifi remains disabled at boot. The saved configuration includes: + * On boards where this is not available, just issue the `connect` commands you + * need to run at startup from an `onInit` function. + * Save the current wifi configuration (station and access point) to flash and + * automatically apply this configuration at boot time, unless `what=="clear"`, in + * which case the saved configuration is cleared such that wifi remains disabled at + * boot. The saved configuration includes: * * mode (off/sta/ap/sta+ap) * * SSIDs & passwords * * phy (11b/g/n) @@ -11490,13 +12341,13 @@ type Libraries = { * @param {any} what - An optional parameter to specify what to save, on the esp8266 the two supported values are `clear` and `sta+ap`. The default is `sta+ap` * @url http://www.espruino.com/Reference#l_Wifi_save */ - save(what: any): any; + save(what: any): void; /** * Restores the saved Wifi configuration from flash. See `Wifi.save()`. * @url http://www.espruino.com/Reference#l_Wifi_restore */ - restore(): any; + restore(): void; /** * Return the station IP information in an object as follows: @@ -11526,17 +12377,20 @@ type Libraries = { getAPIP(callback: any): any; /** - * Lookup the hostname and invoke a callback with the IP address as integer argument. If the lookup fails, the callback is invoked with a null argument. - * **Note:** only a single hostname lookup can be made at a time, concurrent lookups are not supported. + * Lookup the hostname and invoke a callback with the IP address as integer + * argument. If the lookup fails, the callback is invoked with a null argument. + * **Note:** only a single hostname lookup can be made at a time, concurrent + * lookups are not supported. * * @param {any} hostname - The hostname to lookup. * @param {any} callback - The `callback(ip)` to invoke when the IP is returned. `ip==null` on failure. * @url http://www.espruino.com/Reference#l_Wifi_getHostByName */ - getHostByName(hostname: any, callback: any): any; + getHostByName(hostname: any, callback: any): void; /** - * Returns the hostname announced to the DHCP server and broadcast via mDNS when connecting to an access point. + * Returns the hostname announced to the DHCP server and broadcast via mDNS when + * connecting to an access point. * * @param {any} callback - An optional `callback(hostname)` function to be called back with the hostname. * @returns {any} The currently configured hostname, if available immediately. @@ -11545,84 +12399,96 @@ type Libraries = { getHostname(callback: any): any; /** - * Set the hostname. Depending on implemenation, the hostname is sent with every DHCP request and is broadcast via mDNS. The DHCP hostname may be visible in the access point and may be forwarded into DNS as hostname.local. - * If a DHCP lease currently exists changing the hostname will cause a disconnect and reconnect in order to transmit the change to the DHCP server. - * The mDNS announcement also includes an announcement for the "espruino" service. + * Set the hostname. Depending on implemenation, the hostname is sent with every + * DHCP request and is broadcast via mDNS. The DHCP hostname may be visible in the + * access point and may be forwarded into DNS as hostname.local. If a DHCP lease + * currently exists changing the hostname will cause a disconnect and reconnect in + * order to transmit the change to the DHCP server. The mDNS announcement also + * includes an announcement for the "espruino" service. * * @param {any} hostname - The new hostname. * @param {any} callback - An optional `callback()` function to be called back when the hostname is set * @url http://www.espruino.com/Reference#l_Wifi_setHostname */ - setHostname(hostname: any, callback: any): any; + setHostname(hostname: any, callback: any): void; /** - * Starts the SNTP (Simple Network Time Protocol) service to keep the clock synchronized with the specified server. Note that the time zone is really just an offset to UTC and doesn't handle daylight savings time. - * The interval determines how often the time server is queried and Espruino's time is synchronized. The initial synchronization occurs asynchronously after setSNTP returns. + * Starts the SNTP (Simple Network Time Protocol) service to keep the clock + * synchronized with the specified server. Note that the time zone is really just + * an offset to UTC and doesn't handle daylight savings time. The interval + * determines how often the time server is queried and Espruino's time is + * synchronized. The initial synchronization occurs asynchronously after setSNTP + * returns. * * @param {any} server - The NTP server to query, for example, `us.pool.ntp.org` * @param {any} tz_offset - Local time zone offset in the range -11..13. * @url http://www.espruino.com/Reference#l_Wifi_setSNTP */ - setSNTP(server: any, tz_offset: any): any; + setSNTP(server: any, tz_offset: any): void; /** * The `settings` object must contain the following properties. * * `ip` IP address as string (e.g. "192.168.5.100") - * * `gw` The network gateway as string (e.g. "192.168.5.1") + * * `gw` The network gateway as string (e.g. "192.168.5.1") * * `netmask` The interface netmask as string (e.g. "255.255.255.0") * * @param {any} settings - Configuration settings * @param {any} callback - A `callback(err)` function to invoke when ip is set. `err==null` on success, or a string on failure. * @url http://www.espruino.com/Reference#l_Wifi_setIP */ - setIP(settings: any, callback: any): any; + setIP(settings: any, callback: any): void; /** * The `settings` object must contain the following properties. * * `ip` IP address as string (e.g. "192.168.5.100") - * * `gw` The network gateway as string (e.g. "192.168.5.1") + * * `gw` The network gateway as string (e.g. "192.168.5.1") * * `netmask` The interface netmask as string (e.g. "255.255.255.0") * * @param {any} settings - Configuration settings * @param {any} callback - A `callback(err)` function to invoke when ip is set. `err==null` on success, or a string on failure. * @url http://www.espruino.com/Reference#l_Wifi_setAPIP */ - setAPIP(settings: any, callback: any): any; + setAPIP(settings: any, callback: any): void; /** - * Issues a ping to the given host, and calls a callback with the time when the ping is received. + * Issues a ping to the given host, and calls a callback with the time when the + * ping is received. * * @param {any} hostname - The host to ping * @param {any} callback - A `callback(time)` function to invoke when a ping is received * @url http://www.espruino.com/Reference#l_Wifi_ping */ - ping(hostname: any, callback: any): any; + ping(hostname: any, callback: any): void; /** * Switch to using a higher communication speed with the WiFi module. * * `true` = 921600 baud * * `false` = 115200 - * * `1843200` (or any number) = use a specific baud rate. - * * - * eg. `wifi.turbo(true,callback)` or `wifi.turbo(1843200,callback)` + * * `1843200` (or any number) = use a specific baud rate. * eg. + * `wifi.turbo(true,callback)` or `wifi.turbo(1843200,callback)` * * @param {any} enable - true (or a baud rate as a number) to enable, false to disable * @param {any} callback - A `callback()` function to invoke when turbo mode has been set * @url http://www.espruino.com/Reference#l_Wifi_turbo */ - turbo(enable: any, callback: any): any; + turbo(enable: any, callback: any): void; } /** * This library allows you to create http servers and make http requests - * In order to use this, you will need an extra module to get network connectivity such as the [TI CC3000](/CC3000) or [WIZnet W5500](/WIZnet). - * This is designed to be a cut-down version of the [node.js library](http://nodejs.org/api/http.html). Please see the [Internet](/Internet) page for more information on how to use it. + * In order to use this, you will need an extra module to get network connectivity + * such as the [TI CC3000](/CC3000) or [WIZnet W5500](/WIZnet). + * This is designed to be a cut-down version of the [node.js + * library](http://nodejs.org/api/http.html). Please see the [Internet](/Internet) + * page for more information on how to use it. * @url http://www.espruino.com/Reference#http */ http: { /** * Create an HTTP Server - * When a request to the server is made, the callback is called. In the callback you can use the methods on the response (`httpSRs`) to send data. You can also add `request.on('data',function() { ... })` to listen for POSTed data + * When a request to the server is made, the callback is called. In the callback + * you can use the methods on the response (`httpSRs`) to send data. You can also + * add `request.on('data',function() { ... })` to listen for POSTed data * * @param {any} callback - A function(request,response) that will be called when a connection is made * @returns {any} Returns a new httpSrv object @@ -11631,7 +12497,8 @@ type Libraries = { createServer(callback: any): httpSrv; /** - * Create an HTTP Request - `end()` must be called on it to complete the operation. `options` is of the form: + * Create an HTTP Request - `end()` must be called on it to complete the operation. + * `options` is of the form: * ``` * var options = { * host: 'example.com', // host name @@ -11652,10 +12519,12 @@ type Libraries = { * // You can req.write(...) here if your request requires data to be sent. * req.end(); // called to finish the HTTP request and get the response * ``` - * You can easily pre-populate `options` from a URL using `var options = url.parse("http://www.example.com/foo.html")` - * There's an example of using [`http.request` for HTTP POST here](/Internet#http-post) - * **Note:** if TLS/HTTPS is enabled, options can have `ca`, `key` and `cert` fields. See `tls.connect` for - * more information about these and how to use them. + * You can easily pre-populate `options` from a URL using `var options = + * url.parse("http://www.example.com/foo.html")` + * There's an example of using [`http.request` for HTTP POST + * here](/Internet#http-post) + * **Note:** if TLS/HTTPS is enabled, options can have `ca`, `key` and `cert` + * fields. See `tls.connect` for more information about these and how to use them. * * @param {any} options - An object containing host,port,path,method,headers fields (and also ca,key,cert if HTTPS is enabled) * @param {any} callback - A function(res) that will be called when a connection is made. You can then call `res.on('data', function(data) { ... })` and `res.on('close', function() { ... })` to deal with the response. @@ -11665,7 +12534,8 @@ type Libraries = { request(options: any, callback: any): httpCRq; /** - * Request a webpage over HTTP - a convenience function for `http.request()` that makes sure the HTTP command is 'GET', and that calls `end` automatically. + * Request a webpage over HTTP - a convenience function for `http.request()` that + * makes sure the HTTP command is 'GET', and that calls `end` automatically. * ``` * require("http").get("http://pur3.co.uk/hello.txt", function(res) { * res.on('data', function(data) { @@ -11676,7 +12546,8 @@ type Libraries = { * }); * }); * ``` - * See `http.request()` and [the Internet page](/Internet) and ` for more usage examples. + * See `http.request()` and [the Internet page](/Internet) and ` for more usage + * examples. * * @param {any} options - A simple URL, or an object containing host,port,path,method fields * @param {any} callback - A function(res) that will be called when a connection is made. You can then call `res.on('data', function(data) { ... })` and `res.on('close', function() { ... })` to deal with the response. @@ -11735,9 +12606,15 @@ type Libraries = { } /** - * Simple library for compression/decompression using [heatshrink](https://github.com/atomicobject/heatshrink), an [LZSS](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski) compression tool. - * Espruino uses heatshrink internally to compress RAM down to fit in Flash memory when `save()` is used. This just exposes that functionality. - * Functions here take and return buffers of data. There is no support for streaming, so both the compressed and decompressed data must be able to fit in memory at the same time. + * Simple library for compression/decompression using + * [heatshrink](https://github.com/atomicobject/heatshrink), an + * [LZSS](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski) + * compression tool. + * Espruino uses heatshrink internally to compress RAM down to fit in Flash memory + * when `save()` is used. This just exposes that functionality. + * Functions here take and return buffers of data. There is no support for + * streaming, so both the compressed and decompressed data must be able to fit in + * memory at the same time. * @url http://www.espruino.com/Reference#heatshrink */ heatshrink: { @@ -11766,8 +12643,8 @@ type Libraries = { */ neopixel: { /** - * Write to a strip of NeoPixel/WS281x/APA104/APA106/SK6812-style LEDs - * attached to the given pin. + * Write to a strip of NeoPixel/WS281x/APA104/APA106/SK6812-style LEDs attached to + * the given pin. * ``` * // set just one pixel, red, green, blue * require("neopixel").write(B15, [255,0,0]); @@ -11790,77 +12667,76 @@ type Libraries = { * }, 100); * ``` * **Note:** - * * Different types of LED have the data in different orders - so don't - * be surprised by RGB or BGR orderings! - * * Some LED strips (SK6812) actually take 4 bytes per LED (red, green, blue and white). - * These are still supported but the array of data supplied must still be a multiple of 3 - * bytes long. Just round the size up - it won't cause any problems. - * * On some platforms like STM32, pins capable of hardware SPI MOSI - * are required. - * * Espruino devices tend to have 3.3v IO, while WS2812/etc run - * off of 5v. Many WS2812 will only register a logic '1' at 70% - * of their input voltage - so if powering them off 5v you will not - * be able to send them data reliably. You can work around this by - * powering the LEDs off a lower voltage (for example 3.7v from a LiPo - * battery), can put the output into the `af_opendrain` state and use - * a pullup resistor to 5v on STM32 based boards (nRF52 are not 5v tolerant - * so you can't do this), or can use a level shifter to shift the voltage up - * into the 5v range. + * * Different types of LED have the data in different orders - so don't be + * surprised by RGB or BGR orderings! + * * Some LED strips (SK6812) actually take 4 bytes per LED (red, green, blue and + * white). These are still supported but the array of data supplied must still be a + * multiple of 3 bytes long. Just round the size up - it won't cause any problems. + * * On some platforms like STM32, pins capable of hardware SPI MOSI are required. + * * Espruino devices tend to have 3.3v IO, while WS2812/etc run off of 5v. Many + * WS2812 will only register a logic '1' at 70% of their input voltage - so if + * powering them off 5v you will not be able to send them data reliably. You can + * work around this by powering the LEDs off a lower voltage (for example 3.7v from + * a LiPo battery), can put the output into the `af_opendrain` state and use a + * pullup resistor to 5v on STM32 based boards (nRF52 are not 5v tolerant so you + * can't do this), or can use a level shifter to shift the voltage up into the 5v + * range. * * @param {Pin} pin - The Pin the LEDs are connected to * @param {any} data - The data to write to the LED strip (must be a multiple of 3 bytes long) * @url http://www.espruino.com/Reference#l_neopixel_write */ - write(pin: Pin, data: any): any; + write(pin: Pin, data: any): void; } /** - * This module allows you to read and write part of the nonvolatile flash - * memory of your device using a filesystem-like API. - * Also see the `Flash` library, which provides a low level, more dangerous way - * to access all parts of your flash memory. + * This module allows you to read and write part of the nonvolatile flash memory of + * your device using a filesystem-like API. + * Also see the `Flash` library, which provides a low level, more dangerous way to + * access all parts of your flash memory. * The `Storage` library provides two distinct types of file: - * * `require("Storage").write(...)`/`require("Storage").read(...)`/etc create simple - * contiguous files of fixed length. This is the recommended file type. - * * `require("Storage").open(...)` creates a `StorageFile`, which stores the file in - * numbered chunks (`"filename\1"`/`"filename\2"`/etc). It allows data to be appended - * and for the file to be read line by line. - * You must read a file using the same method you used to write it - eg. you can't create a - * file with `require("Storage").open(...)` and then read it with `require("Storage").read(...)`. - * **Note:** In firmware 2v05 and later, the maximum length for filenames - * is 28 characters. However in 2v04 and earlier the max length is 8. + * * `require("Storage").write(...)`/`require("Storage").read(...)`/etc create + * simple contiguous files of fixed length. This is the recommended file type. + * * `require("Storage").open(...)` creates a `StorageFile`, which stores the file + * in numbered chunks (`"filename\1"`/`"filename\2"`/etc). It allows data to be + * appended and for the file to be read line by line. + * You must read a file using the same method you used to write it - eg. you can't + * create a file with `require("Storage").open(...)` and then read it with + * `require("Storage").read(...)`. + * **Note:** In firmware 2v05 and later, the maximum length for filenames is 28 + * characters. However in 2v04 and earlier the max length is 8. * @url http://www.espruino.com/Reference#Storage */ Storage: { /** - * Erase the flash storage area. This will remove all files - * created with `require("Storage").write(...)` as well - * as any code saved with `save()` or `E.setBootCode()`. + * Erase the flash storage area. This will remove all files created with + * `require("Storage").write(...)` as well as any code saved with `save()` or + * `E.setBootCode()`. * @url http://www.espruino.com/Reference#l_Storage_eraseAll */ - eraseAll(): any; + eraseAll(): void; /** * Erase a single file from the flash storage area. - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @url http://www.espruino.com/Reference#l_Storage_erase */ - erase(name: any): any; + erase(name: string): void; /** - * Read a file from the flash storage area that has - * been written with `require("Storage").write(...)`. - * This function returns a memory-mapped String that points to the actual - * memory area in read-only memory, so it won't use up RAM. - * As such you can check if a file exists efficiently using `require("Storage").read(filename)!==undefined`. - * If you evaluate this string with `eval`, any functions - * contained in the String will keep their code stored - * in flash memory. - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * Read a file from the flash storage area that has been written with + * `require("Storage").write(...)`. + * This function returns a memory-mapped String that points to the actual memory + * area in read-only memory, so it won't use up RAM. + * As such you can check if a file exists efficiently using + * `require("Storage").read(filename)!==undefined`. + * If you evaluate this string with `eval`, any functions contained in the String + * will keep their code stored in flash memory. + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @param {number} offset - (optional) The offset in bytes to start from @@ -11868,56 +12744,54 @@ type Libraries = { * @returns {any} A string of data, or `undefined` if the file is not found * @url http://www.espruino.com/Reference#l_Storage_read */ - read(name: any, offset: number, length: number): any; + read(name: string, offset?: number, length?: number): string | undefined; /** - * Read a file from the flash storage area that has - * been written with `require("Storage").write(...)`, - * and parse JSON in it into a JavaScript object. - * This is identical to `JSON.parse(require("Storage").read(...))`. - * It will throw an exception if the data in the file is not - * valid JSON. - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * Read a file from the flash storage area that has been written with + * `require("Storage").write(...)`, and parse JSON in it into a JavaScript object. + * This is identical to `JSON.parse(require("Storage").read(...))`. It will throw + * an exception if the data in the file is not valid JSON. + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @param {boolean} noExceptions - If true and the JSON is not valid, just return `undefined` - otherwise an `Exception` is thrown * @returns {any} An object containing parsed JSON from the file, or undefined * @url http://www.espruino.com/Reference#l_Storage_readJSON */ - readJSON(name: any, noExceptions: boolean): any; + readJSON(name: string, noExceptions: boolean): any; /** - * Read a file from the flash storage area that has - * been written with `require("Storage").write(...)`, - * and return the raw binary data as an ArrayBuffer. + * Read a file from the flash storage area that has been written with + * `require("Storage").write(...)`, and return the raw binary data as an + * ArrayBuffer. * This can be used: * * In a `DataView` with `new DataView(require("Storage").readArrayBuffer("x"))` - * * In a `Uint8Array/Float32Array/etc` with `new Uint8Array(require("Storage").readArrayBuffer("x"))` - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * * In a `Uint8Array/Float32Array/etc` with `new + * Uint8Array(require("Storage").readArrayBuffer("x"))` + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @returns {any} An ArrayBuffer containing data from the file, or undefined * @url http://www.espruino.com/Reference#l_Storage_readArrayBuffer */ - readArrayBuffer(name: any): any; + readArrayBuffer(name: string): ArrayBuffer | undefined; /** - * Write/create a file in the flash storage area. This is - * nonvolatile and will not disappear when the device resets - * or power is lost. - * Simply write `require("Storage").write("MyFile", "Some data")` to write - * a new file, and `require("Storage").read("MyFile")` to read it. + * Write/create a file in the flash storage area. This is nonvolatile and will not + * disappear when the device resets or power is lost. + * Simply write `require("Storage").write("MyFile", "Some data")` to write a new + * file, and `require("Storage").read("MyFile")` to read it. * If you supply: * * A String, it will be written as-is * * An array, will be written as a byte array (but read back as a String) - * * An object, it will automatically be converted to - * a JSON string before being written. - * **Note:** If an array is supplied it will not be converted to JSON. - * To be explicit about the conversion you can use `Storage.writeJSON` - * You may also create a file and then populate data later **as long as you - * don't try and overwrite data that already exists**. For instance: + * * An object, it will automatically be converted to a JSON string before being + * written. + * **Note:** If an array is supplied it will not be converted to JSON. To be + * explicit about the conversion you can use `Storage.writeJSON` + * You may also create a file and then populate data later **as long as you don't + * try and overwrite data that already exists**. For instance: * ``` * var f = require("Storage"); * f.write("a","Hello",0,14); @@ -11927,11 +12801,11 @@ type Libraries = { * f.write("a"," ",0); // Writing to location 0 again will cause the file to be re-written * print(f.read("a")); // " " * ``` - * This can be useful if you've got more data to write than you - * have RAM available - for instance the Web IDE uses this method - * to write large files into onboard storage. - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * This can be useful if you've got more data to write than you have RAM + * available - for instance the Web IDE uses this method to write large files into + * onboard storage. + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @param {any} data - The data to write @@ -11940,24 +12814,23 @@ type Libraries = { * @returns {boolean} True on success, false on failure * @url http://www.espruino.com/Reference#l_Storage_write */ - write(name: any, data: any, offset?: number, size?: number): boolean; + write(name: string | ArrayBuffer | ArrayBufferView | number[] | object, data: any, offset?: number, size?: number): boolean; /** - * Write/create a file in the flash storage area. This is - * nonvolatile and will not disappear when the device resets - * or power is lost. - * Simply write `require("Storage").writeJSON("MyFile", [1,2,3])` to write - * a new file, and `require("Storage").readJSON("MyFile")` to read it. + * Write/create a file in the flash storage area. This is nonvolatile and will not + * disappear when the device resets or power is lost. + * Simply write `require("Storage").writeJSON("MyFile", [1,2,3])` to write a new + * file, and `require("Storage").readJSON("MyFile")` to read it. * This is equivalent to: `require("Storage").write(name, JSON.stringify(data))` - * **Note:** This function should be used with normal files, and not - * `StorageFile`s created with `require("Storage").open(filename, ...)` + * **Note:** This function should be used with normal files, and not `StorageFile`s + * created with `require("Storage").open(filename, ...)` * * @param {any} name - The filename - max 28 characters (case sensitive) * @param {any} data - The JSON data to write * @returns {boolean} True on success, false on failure * @url http://www.espruino.com/Reference#l_Storage_writeJSON */ - writeJSON(name: any, data: any): boolean; + writeJSON(name: string, data: any): boolean; /** * List all files in the flash storage area. An array of Strings is returned. @@ -11973,69 +12846,65 @@ type Libraries = { * // All normal files (eg created with Storage.write) * require("Storage").list(undefined, {sf:false}) * ``` - * **Note:** This will output system files (eg. saved code) as well as - * files that you may have written. + * **Note:** This will output system files (eg. saved code) as well as files that + * you may have written. * * @param {any} regex - (optional) If supplied, filenames are checked against this regular expression (with `String.match(regexp)`) to see if they match before being returned * @param {any} filter - (optional) If supplied, File Types are filtered based on this: `{sf:true}` or `{sf:false}` for whether to show StorageFile * @returns {any} An array of filenames * @url http://www.espruino.com/Reference#l_Storage_list */ - list(regex: any, filter: any): any; + list(regex?: RegExp, filter?: { sf: boolean }): string[]; /** - * List all files in the flash storage area matching the specfied regex (ignores StorageFiles), - * and then hash their filenames *and* file locations. - * Identical files may have different hashes (eg. if Storage is compacted and the file moves) but - * the changes of different files having the same hash are extremely small. + * List all files in the flash storage area matching the specfied regex (ignores + * StorageFiles), and then hash their filenames *and* file locations. + * Identical files may have different hashes (eg. if Storage is compacted and the + * file moves) but the changes of different files having the same hash are + * extremely small. * ``` * // Hash files * require("Storage").hash() * // Files ending in '.boot.js' * require("Storage").hash(/\.boot\.js$/) * ``` - * **Note:** This function is used by Bangle.js as a way to cache files. - * For instance the bootloader will add all `.boot.js` files together into - * a single `.boot0` file, but it needs to know quickly whether anything has - * changed. + * **Note:** This function is used by Bangle.js as a way to cache files. For + * instance the bootloader will add all `.boot.js` files together into a single + * `.boot0` file, but it needs to know quickly whether anything has changed. * * @param {any} regex - (optional) If supplied, filenames are checked against this regular expression (with `String.match(regexp)`) to see if they match before being hashed * @returns {number} A hash of the files matching * @url http://www.espruino.com/Reference#l_Storage_hash */ - hash(regex: any): number; + hash(regex: RegExp): number; /** - * The Flash Storage system is journaling. To make the most of the limited - * write cycles of Flash memory, Espruino marks deleted/replaced files as - * garbage and moves on to a fresh part of flash memory. Espruino only - * fully erases those files when it is running low on flash, or when - * `compact` is called. - * `compact` may fail if there isn't enough RAM free on the stack to - * use as swap space, however in this case it will not lose data. - * **Note:** `compact` rearranges the contents of memory. If code is - * referencing that memory (eg. functions that have their code stored in flash) - * then they may become garbled when compaction happens. To avoid this, - * call `eraseFiles` before uploading data that you intend to reference to - * ensure that uploaded files are right at the start of flash and cannot be - * compacted further. + * The Flash Storage system is journaling. To make the most of the limited write + * cycles of Flash memory, Espruino marks deleted/replaced files as garbage and + * moves on to a fresh part of flash memory. Espruino only fully erases those files + * when it is running low on flash, or when `compact` is called. + * `compact` may fail if there isn't enough RAM free on the stack to use as swap + * space, however in this case it will not lose data. + * **Note:** `compact` rearranges the contents of memory. If code is referencing + * that memory (eg. functions that have their code stored in flash) then they may + * become garbled when compaction happens. To avoid this, call `eraseFiles` before + * uploading data that you intend to reference to ensure that uploaded files are + * right at the start of flash and cannot be compacted further. * @url http://www.espruino.com/Reference#l_Storage_compact */ - compact(): any; + compact(): void; /** - * This writes information about all blocks in flash - * memory to the console - and is only useful for debugging - * flash storage. + * This writes information about all blocks in flash memory to the console - and is + * only useful for debugging flash storage. * @url http://www.espruino.com/Reference#l_Storage_debug */ - debug(): any; + debug(): void; /** - * Return the amount of free bytes available in - * Storage. Due to fragmentation there may be more - * bytes available, but this represents the maximum - * size of file that can be written. + * Return the amount of free bytes available in Storage. Due to fragmentation there + * may be more bytes available, but this represents the maximum size of file that + * can be written. * @returns {number} The amount of free bytes * @url http://www.espruino.com/Reference#l_Storage_getFree */ @@ -12059,11 +12928,11 @@ type Libraries = { getStats(): any; /** - * Writes a lookup table for files into Bangle.js's storage. This allows any file stored - * up to that point to be accessed quickly. + * Writes a lookup table for files into Bangle.js's storage. This allows any file + * stored up to that point to be accessed quickly. * @url http://www.espruino.com/Reference#l_Storage_optimise */ - optimise(): any; + optimise(): void; /** * Open a file in the Storage area. This can be used for appending data @@ -12076,22 +12945,24 @@ type Libraries = { * @returns {any} An object containing {read,write,erase} * @url http://www.espruino.com/Reference#l_Storage_open */ - open(name: any, mode: any): StorageFile; + open(name: string, mode: "r" | "w" | "a"): StorageFile; } /** - * This module allows you to read and write the nonvolatile flash memory of your device. - * Also see the `Storage` library, which provides a safer file-like - * interface to nonvolatile storage. - * It should be used with extreme caution, as it is easy to overwrite parts of Flash - * memory belonging to Espruino or even its bootloader. If you damage the bootloader - * then you may need external hardware such as a USB-TTL converter to restore it. For - * more information on restoring the bootloader see `Advanced Reflashing` in your - * board's reference pages. + * This module allows you to read and write the nonvolatile flash memory of your + * device. + * Also see the `Storage` library, which provides a safer file-like interface to + * nonvolatile storage. + * It should be used with extreme caution, as it is easy to overwrite parts of + * Flash memory belonging to Espruino or even its bootloader. If you damage the + * bootloader then you may need external hardware such as a USB-TTL converter to + * restore it. For more information on restoring the bootloader see `Advanced + * Reflashing` in your board's reference pages. * To see which areas of memory you can and can't overwrite, look at the values * reported by `process.memory()`. * **Note:** On Nordic platforms there are checks in place to help you avoid - * 'bricking' your device be damaging the bootloader. You can disable these with `E.setFlags({unsafeFlash:1})` + * 'bricking' your device be damaging the bootloader. You can disable these with + * `E.setFlags({unsafeFlash:1})` * @url http://www.espruino.com/Reference#Flash */ Flash: { @@ -12105,11 +12976,12 @@ type Libraries = { getPage(addr: number): any; /** - * This method returns an array of objects of the form `{addr : #, length : #}`, representing - * contiguous areas of flash memory in the chip that are not used for anything. - * The memory areas returned are on page boundaries. This means that you can - * safely erase the page containing any address here, and you won't risk - * deleting part of the Espruino firmware. + * This method returns an array of objects of the form `{addr : #, length : #}`, + * representing contiguous areas of flash memory in the chip that are not used for + * anything. + * The memory areas returned are on page boundaries. This means that you can safely + * erase the page containing any address here, and you won't risk deleting part of + * the Espruino firmware. * @returns {any} Array of objects with `addr` and `length` properties * @url http://www.espruino.com/Reference#l_Flash_getFree */ @@ -12121,20 +12993,20 @@ type Libraries = { * @param {any} addr - An address in the page that is to be erased * @url http://www.espruino.com/Reference#l_Flash_erasePage */ - erasePage(addr: any): any; + erasePage(addr: any): void; /** * Write data into memory at the given address * In flash memory you may only turn bits that are 1 into bits that are 0. If * you're writing data into an area that you have already written (so `read` - * doesn't return all `0xFF`) you'll need to call `erasePage` to clear the - * entire page. + * doesn't return all `0xFF`) you'll need to call `erasePage` to clear the entire + * page. * * @param {any} data - The data to write * @param {number} addr - The address to start writing from * @url http://www.espruino.com/Reference#l_Flash_write */ - write(data: any, addr: number): any; + write(data: any, addr: number): void; /** * Read flash memory from the given address