blinkstick-ts/dist/blinksticks.d.ts

BlinkStick TypeScript implementation

import { BlinkStick } from "./blinkstick";
export declare class BlinkSticks {
    /**
     * Find first attached BlinkStick.
     *
     * @example
     *     var blinkstick = require('blinkstick');
     *     var led = blinkstick.findFirst();
     *
     * @static
     * @method findFirst
     * @return {BlinkStick|undefined} The first BlinkStick, if found.
     */
    findFirst(): BlinkStick | undefined;
    /**
     * Find all attached BlinkStick devices.
     *
     * @example
     *     var blinkstick = require('blinkstick');
     *     var leds = blinkstick.findAll();
     *
     * @static
     * @method findAll
     * @return {Array} BlinkSticks.
     */
    findAll(): BlinkStick[];
    /**
     * Returns the serial numbers of all attached BlinkStick devices.
     *
     * @static
     * @method findAllSerials
     * @return {Array} Serial numbers.
     */
    findAllSerials(): (string | undefined)[];
    /**
     * Find BlinkStick device based on serial number.
     *
     * @static
     * @method findBySerial
     * @param {Number} serial Serial number.
     * @param {Function} callback Callback when BlinkStick has been found
     */
    findBySerial(serial: string): BlinkStick | undefined;
    /**
     * Find BlinkSticks using a filter.
     *
     * @method findBlinkSticks
     * @param {Function} [filter] Filter function.
     * @return {Array} BlickStick objects.
     */
    private findBlinkSticks;
}