UNPKG

1.25 kBTypeScriptView Raw
1import { LocalBootstrap } from './http/LocalBootstrap';
2import { LocalInsecureBootstrap } from './http/LocalInsecureBootstrap';
3import { RemoteBootstrap } from './http/RemoteBootstrap';
4import { HueApiRateLimits } from './HueApiRateLimits';
5/**
6 * Creates a remote bootstrap to connect with a Hue bridge remotely
7 * @param clientId The OAuth client id for your application.
8 * @param clientSecret The OAuth client secret for your application.
9 */
10export declare function createRemote(clientId: string, clientSecret: string, rateLimits?: HueApiRateLimits): RemoteBootstrap;
11/**
12 * Creates a local network bootstrap to connect with Hue bridge on a local network.
13 * @param host The IP Address or FQDN of the he bridge you are connecting to.
14 * @param port The port number to connect to, optional.
15 */
16export declare function createLocal(host: string, port?: number, rateLimits?: HueApiRateLimits): LocalBootstrap;
17/**
18 * Creates a local network bootstrap over an insecure HTTP connection.
19 * @param host The IP Address or FQDN of the he bridge you are connecting to.
20 * @param port The port number to connect to, optional.
21 */
22export declare function createInsecureLocal(host: string, port?: number, rateLimits?: HueApiRateLimits): LocalInsecureBootstrap;