Add missing types to client events, light properties, product details #45

AdamCoulterOz · 2021-12-07T14:08:31Z

No description provided.

ristomatti

Nice improvements, thanks! I've added a few comments.

src/lifx.d.ts

ristomatti · 2021-12-07T20:56:58Z

I've renamed the PR to better reflect the changes.

ristomatti · 2021-12-16T08:57:13Z

src/lifx.d.ts

+import {EventEmitter} from 'eventemitter3';
+import {AddressInfo} from 'net';
+
+export class ClientOptions {


Thanks for defining these also but this shold definately be an interface as it's passed in as a plain object.

Rationale for Utilizing ClientOptions as a Class

1. Encapsulation:

Having ClientOptions as a class allows for the encapsulation of default values alongside the option attributes.

This encapsulation makes it straightforward to manage default values in a centralized location, thereby reducing the complexity in the init method where these options are utilized.

2. Ease of Use:

The class constructor can easily merge user-provided options with default values, providing a clean, intuitive interface for consumers.

This also streamlines the code in the init method, as it can assume that all necessary options are properly initialized.

3. Type Safety:

The class structure ensures type safety for the configuration options while allowing for partial overriding of default values.

This is beneficial for maintaining code integrity and reducing potential runtime errors.

export class ClientOptions { /** The IPv4 address to bind to */ address: string = '0.0.0.0'; /** The port to bind to */ port: number = 0; /** Show debug output */ debug: boolean = false; // ... other properties with default values ... constructor(options?: Partial<ClientOptions>) { Object.assign(this, options); } } const options = new ClientOptions({ address: '127.0.0.1', debug: true });

ristomatti · 2021-12-16T08:58:48Z

src/lifx.d.ts

-  * @param {Function} [callback] Called after initialation
-  */
-  init(options: any, callback: any): any;
+  /** Creates a new socket and starts discovery */


Please revert this back. The JSDoc's are shown in IDE's when you hover over the function.

ristomatti · 2021-12-16T09:05:31Z

src/lifx.d.ts

  */
-  light(identifier: any): any;
+  light(identifier: string): Light | false;


Please revert the JSDoc as it was. It's simpler to have the same text here as in the code. The types in JSDocs are unnecessary though, so you're welcome to remove them if you wish.

ristomatti · 2021-12-16T09:07:41Z

src/lifx.d.ts

+import {AddressInfo} from 'net';
+
+export class ClientOptions {
+  /** The IPv4 address to bind to  */


At least WebStorm doesn't seem to show these when I hover over client.init so these aren't much of use here. See my comments on the client interface.

They should. It does in vscode.

ristomatti · 2021-12-16T09:08:05Z

src/lifx.d.ts

  */
-  color(hue: any, saturation: any, brightness: any, kelvin: any, duration: any, callback: any): void;
+  color(hue: number, saturation: number, brightness: number, kelvin: number, duration: number, callback: (err: Error) => void): void;


ristomatti · 2021-12-16T09:08:46Z

src/lifx.d.ts

+   * @param apply apply changes immediately or leave pending for next apply
+   * @param callback called when light did receive message
+   */
+  colorZones(startIndex: number, endIndex: number, hue: number, saturation: number, brightness: number, kelvin: number, duration: number, apply: boolean, callback: (err: Error, msg: any, rinfo: RemoteInfo) => void): void;


ristomatti · 2021-12-16T09:10:53Z

src/lifx.d.ts

+  saturation: number;
+}
+
+export class constants {


Revert this back to const as that's what it is. We're not instantiating it anywhere. This could also break someones code ( I think).

ristomatti · 2021-12-16T09:47:09Z

src/lifx.d.ts

-export class Client {
+import {RemoteInfo} from 'dgram';
+import {EventEmitter} from 'eventemitter3';
+import {AddressInfo} from 'net';


If we're referencing types from other packages, I believe we should have them as dev dependencies in package.json also.

Here's a clarification:

Core Node Modules (dgram and net):

These are included with Node.js, and their types are covered by the @types/node dev dependency.

eventemitter3:

Agreed. I've added eventemitter3 as a dev dependency.

ristomatti · 2021-12-16T09:50:26Z

src/lifx.d.ts

@@ -403,137 +356,15 @@ export const constants: {
  TAGGED_BIT: number;
  ZONE_INDEX_MAXIMUM_VALUE: number;
  ZONE_INDEX_MINIMUM_VALUE: number;
-};
-
-export namespace packet {


I did not ask to remove this. I know some people use these to overcome the lack of some features on this library. Please revert.

ristomatti · 2021-12-16T09:55:57Z

src/lifx.d.ts

 }

-export namespace utils {
+export interface utils {


Please revert this to namespace and as it where. I don't think it's a good idea to remove types we've previously published. I might have made a mention on private/public APIs but since the functions in utils had JSDoc's, they could be used by some.

ristomatti · 2021-12-16T10:00:04Z

Sorry about the amount of comments but there was a lot of unexpected changes. Some good, some not.

At least for me autocomplete is quite broken now. Did you test these?

Before:

After:

So with the changes it would seem it's not possible to create a new client instance (unless I'm doing something wrong with my quick testing).

AdamCoulterOz added 2 commits December 8, 2021 01:08

add type information for product details

8e3ae88

add typed events

a7a7644

AdamCoulterOz changed the title ~~add type information for product details~~ add type information for product details and client events Dec 7, 2021

add light attributes to type

ca75ea7

ristomatti reviewed Dec 7, 2021

View reviewed changes

ristomatti changed the title ~~add type information for product details and client events~~ Add missing types to client events, light properties, product details Dec 7, 2021

removed private interfaces, added types for all public interfaces

8f94543

ristomatti requested changes Dec 16, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing types to client events, light properties, product details #45

Add missing types to client events, light properties, product details #45

AdamCoulterOz commented Dec 7, 2021

ristomatti left a comment

ristomatti commented Dec 7, 2021

ristomatti Dec 16, 2021

AdamCoulterOz Oct 14, 2023

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

AdamCoulterOz Oct 13, 2023

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

AdamCoulterOz Oct 13, 2023 •

edited

Loading

ristomatti Dec 16, 2021

ristomatti Dec 16, 2021

ristomatti commented Dec 16, 2021

Add missing types to client events, light properties, product details #45

Are you sure you want to change the base?

Add missing types to client events, light properties, product details #45

Conversation

AdamCoulterOz commented Dec 7, 2021

ristomatti left a comment

Choose a reason for hiding this comment

ristomatti commented Dec 7, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rationale for Utilizing ClientOptions as a Class

1. Encapsulation:

2. Ease of Use:

3. Type Safety:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdamCoulterOz Oct 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ristomatti commented Dec 16, 2021

Rationale for Utilizing `ClientOptions` as a Class

AdamCoulterOz Oct 13, 2023 •

edited

Loading