feat: make options optional

jvandenaardweg · Dec 15, 2022 · e28c626 · e28c626
1 parent 15f6084
commit e28c626
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/src/api.test.ts b/src/api.test.ts
@@ -16,9 +16,7 @@ let homeWizardEnergyApi: HomeWizardEnergyApi;
 
 describe('HomeWizardEnergyApi', () => {
   beforeEach(() => {
-    homeWizardEnergyApi = new HomeWizardEnergyApi(mockApiUrl, {
-      logger: vi.fn(),
-    });
+    homeWizardEnergyApi = new HomeWizardEnergyApi(mockApiUrl);
 
     mockApiAgent = new MockAgent({
       bodyTimeout: 10,

diff --git a/src/api.ts b/src/api.ts
@@ -13,7 +13,7 @@ export class HomeWizardEnergyApi extends Base {
   public p1Meter: P1MeterApi;
   public waterMeter: WaterMeterApi;
 
-  constructor(baseUrl: string, options: HomeWizardEnergyApiOptions) {
+  constructor(baseUrl: string, options?: HomeWizardEnergyApiOptions) {
     super(baseUrl, options);
 
     this.energySocket = new EnergySocketApi(baseUrl, options);

diff --git a/src/base.ts b/src/base.ts
@@ -24,8 +24,10 @@ export class HomeWizardEnergyApiResponseError extends HomeWizardEnergyApiError {
 }
 
 export interface HomeWizardEnergyApiOptions {
+  /** The API version to be used. Defaults to `v1` */
   apiVersion?: 'v1' | undefined;
-  requestOptions?: Omit<RequestParameters[1], 'method'>;
+  /** Request options to be used in the HTTP request to the API. */
+  requestOptions?: RequestParameters[1];
   logger?: (...args: unknown[]) => void;
 }
 
@@ -35,17 +37,17 @@ export class Base {
   protected requestOptions: HomeWizardEnergyApiOptions['requestOptions'];
   protected logger: HomeWizardEnergyApiOptions['logger'];
 
-  constructor(baseUrl: string, options: HomeWizardEnergyApiOptions) {
+  constructor(baseUrl: string, options?: HomeWizardEnergyApiOptions) {
     this.baseUrl = baseUrl;
-    this.apiVersion = options.apiVersion || 'v1';
+    this.apiVersion = options?.apiVersion || 'v1';
     this.requestOptions = {
       bodyTimeout: 1000, // 1 seconds, we are on a local network, so all request should be fast
       headersTimeout: 1000,
       // Allow user to overwrite the defaults
-      ...options.requestOptions,
+      ...options?.requestOptions,
     };
 
-    this.logger = options.logger || console.log;
+    this.logger = options?.logger;
   }
 
   protected get endpoints() {

diff --git a/src/energy-socket-api.ts b/src/energy-socket-api.ts
@@ -13,7 +13,7 @@ export class EnergySocketApi extends Base {
   public getBasicInformation: () => Promise<BasicInformationResponse>;
   public getData: <T extends EnergySocketDataResponse>() => Promise<T>;
 
-  constructor(baseUrl: string, options: HomeWizardEnergyApiOptions) {
+  constructor(baseUrl: string, options?: HomeWizardEnergyApiOptions) {
     super(baseUrl, options);
 
     this.getBasicInformation = super.getBasicInformation;

diff --git a/src/p1-meter-api.ts b/src/p1-meter-api.ts
@@ -5,7 +5,7 @@ export class P1MeterApi extends Base {
   public getBasicInformation: () => Promise<BasicInformationResponse>;
   public getData: <T extends P1MeterDataResponse>() => Promise<T>;
 
-  constructor(baseUrl: string, options: HomeWizardEnergyApiOptions) {
+  constructor(baseUrl: string, options?: HomeWizardEnergyApiOptions) {
     super(baseUrl, options);
 
     this.getBasicInformation = super.getBasicInformation;

diff --git a/src/water-meter-api.ts b/src/water-meter-api.ts
@@ -5,7 +5,7 @@ export class WaterMeterApi extends Base {
   public getBasicInformation: () => Promise<BasicInformationResponse>;
   public getData: <T extends WaterMeterDataResponse>() => Promise<T>;
 
-  constructor(baseUrl: string, options: HomeWizardEnergyApiOptions) {
+  constructor(baseUrl: string, options?: HomeWizardEnergyApiOptions) {
     super(baseUrl, options);
 
     this.getBasicInformation = super.getBasicInformation;