@ginden/blinkstick-v2
Version:
Improved Blickstick API for Node.js
26 lines • 1.18 kB
TypeScript
import { type BlinkstickSync } from '../../../core';
import { DiscoveryFilter } from '../../discovery-filter';
/**
* @summary Find first attached BlinkStick and create a BlinkStickSync object.
* @remarks Optionally takes a filter (device name or function) to find a specific BlinkStick.
* Returns null if no BlinkStick is found.
* @category Discovery
*/
export declare function findFirstSync(discoveryFilter?: DiscoveryFilter): BlinkstickSync | null;
/**
* @deprecated Use proper named export findFirstSync instead.
*/
export { findFirstSync as findFirst };
/**
* @summary Find first attached BlinkStick asynchronously and create a BlinkStickAsync instance.
* @category Discovery
*/
export declare function findFirstAsync(discoveryFilter?: DiscoveryFilter): Promise<import("../../../core").BlinkstickAsync | null>;
/**
* @summary Finds a blinkstick by its ID.
* @param id The ID of the blinkstick to find, created via `blinkstick.id`.
* @returns The found blinkstick or null if not found.
* @category Discovery
*/
export declare function findByIdAsync(id: string): Promise<import("../../../core").BlinkstickAsync | null>;
//# sourceMappingURL=find-first.d.ts.map