node-hue-api
Version:
Philips Hue API Library for Node.js
23 lines (22 loc) • 1.25 kB
TypeScript
import { LocalBootstrap } from './http/LocalBootstrap';
import { LocalInsecureBootstrap } from './http/LocalInsecureBootstrap';
import { RemoteBootstrap } from './http/RemoteBootstrap';
import { HueApiRateLimits } from './HueApiRateLimits';
/**
* Creates a remote bootstrap to connect with a Hue bridge remotely
* @param clientId The OAuth client id for your application.
* @param clientSecret The OAuth client secret for your application.
*/
export declare function createRemote(clientId: string, clientSecret: string, rateLimits?: HueApiRateLimits): RemoteBootstrap;
/**
* Creates a local network bootstrap to connect with Hue bridge on a local network.
* @param host The IP Address or FQDN of the he bridge you are connecting to.
* @param port The port number to connect to, optional.
*/
export declare function createLocal(host: string, port?: number, rateLimits?: HueApiRateLimits): LocalBootstrap;
/**
* Creates a local network bootstrap over an insecure HTTP connection.
* @param host The IP Address or FQDN of the he bridge you are connecting to.
* @param port The port number to connect to, optional.
*/
export declare function createInsecureLocal(host: string, port?: number, rateLimits?: HueApiRateLimits): LocalInsecureBootstrap;