Function configure

Configures the library for API interactions. Initializes API methods with a specified base URL.

Example

const api = configure();
const power = await api.getPower(jwtToken, macAddress);
  • configure(
        baseURL?: string,
    ): {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<DeviceInfoType>;
        getEnvironmentTemperature: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<number>;
        getPower: (jwtToken: string, macAddress: string) => Promise<boolean>;
        getTargetTemperature: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<number>;
        setPower: (
            jwtToken: string,
            macAddress: string,
            value: number,
        ) => Promise<AxiosResponse<any, any>>;
        setPowerOff: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<any, any>>;
        setPowerOn: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<any, any>>;
        setTargetTemperature: (
            jwtToken: string,
            macAddress: string,
            temperature: number,
        ) => Promise<AxiosResponse<any, any>>;
    }

  • Parameters

    • OptionalbaseURL: string = API_URL

      The base URL for the API.

    Returns {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<DeviceInfoType>;
        getEnvironmentTemperature: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<number>;
        getPower: (jwtToken: string, macAddress: string) => Promise<boolean>;
        getTargetTemperature: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<number>;
        setPower: (
            jwtToken: string,
            macAddress: string,
            value: number,
        ) => Promise<AxiosResponse<any, any>>;
        setPowerOff: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<any, any>>;
        setPowerOn: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<any, any>>;
        setTargetTemperature: (
            jwtToken: string,
            macAddress: string,
            temperature: number,
        ) => Promise<AxiosResponse<any, any>>;
    }

    • An object containing methods for interacting with the API.
    • deviceInfo: (jwtToken: string, macAddress: string) => Promise<DeviceInfoType>
    • getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>
    • getPower: (jwtToken: string, macAddress: string) => Promise<boolean>
    • getTargetTemperature: (jwtToken: string, macAddress: string) => Promise<number>
    • setPower: (
          jwtToken: string,
          macAddress: string,
          value: number,
      ) => Promise<AxiosResponse<any, any>>
    • setPowerOff: (jwtToken: string, macAddress: string) => Promise<AxiosResponse<any, any>>
    • setPowerOn: (jwtToken: string, macAddress: string) => Promise<AxiosResponse<any, any>>
    • setTargetTemperature: (
          jwtToken: string,
          macAddress: string,
          temperature: number,
      ) => Promise<AxiosResponse<any, any>>

Settings

Member Visibility