Replaced function arg deconstruction with options pattern

rubenthoms · Jan 23, 2024 · 8b8d9ad · 8b8d9ad
1 parent f0d7eff
commit 8b8d9ad
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 44 deletions.
diff --git a/frontend/src/framework/Module.tsx b/frontend/src/framework/Module.tsx
@@ -31,6 +31,16 @@ export enum ImportState {
     Failed = "Failed",
 }
 
+export interface ModuleOptions {
+    name: string;
+    defaultTitle: string;
+    syncableSettingKeys?: SyncSettingKey[];
+    drawPreviewFunc?: DrawPreviewFunc;
+    description?: string;
+    channelDefinitions?: ChannelDefinition[];
+    channelReceiverDefinitions?: ChannelReceiverDefinition[];
+}
+
 export class Module<StateType extends StateBaseType> {
     private _name: string;
     private _defaultTitle: string;
@@ -47,36 +57,20 @@ export class Module<StateType extends StateBaseType> {
     private _channelDefinitions: ChannelDefinition[] | null;
     private _channelReceiverDefinitions: ChannelReceiverDefinition[] | null;
 
-    constructor({
-        name,
-        defaultTitle,
-        syncableSettingKeys,
-        drawPreviewFunc,
-        description,
-        channelDefinitions,
-        channelReceiverDefinitions,
-    }: {
-        name: string;
-        defaultTitle: string;
-        syncableSettingKeys?: SyncSettingKey[];
-        drawPreviewFunc?: DrawPreviewFunc;
-        description?: string;
-        channelDefinitions?: ChannelDefinition[];
-        channelReceiverDefinitions?: ChannelReceiverDefinition[];
-    }) {
-        this._name = name;
-        this._defaultTitle = defaultTitle;
+    constructor(options: ModuleOptions) {
+        this._name = options.name;
+        this._defaultTitle = options.defaultTitle;
         this.viewFC = () => <div>Not defined</div>;
         this.settingsFC = () => <div>Not defined</div>;
         this._importState = ImportState.NotImported;
         this._moduleInstances = [];
         this._defaultState = null;
         this._workbench = null;
-        this._syncableSettingKeys = syncableSettingKeys ?? [];
-        this._drawPreviewFunc = drawPreviewFunc ?? null;
-        this._description = description ?? null;
-        this._channelDefinitions = channelDefinitions ?? null;
-        this._channelReceiverDefinitions = channelReceiverDefinitions ?? null;
+        this._syncableSettingKeys = options.syncableSettingKeys ?? [];
+        this._drawPreviewFunc = options.drawPreviewFunc ?? null;
+        this._description = options.description ?? null;
+        this._channelDefinitions = options.channelDefinitions ?? null;
+        this._channelReceiverDefinitions = options.channelReceiverDefinitions ?? null;
     }
 
     getDrawPreviewFunc(): DrawPreviewFunc | null {

diff --git a/frontend/src/framework/ModuleInstance.ts b/frontend/src/framework/ModuleInstance.ts
@@ -18,6 +18,13 @@ export enum ModuleInstanceState {
     RESETTING,
 }
 
+export interface ModuleInstanceOptions<StateType extends StateBaseType> {
+    module: Module<StateType>;
+    instanceNumber: number;
+    channelDefinitions: ChannelDefinition[] | null;
+    channelReceiverDefinitions: ChannelReceiverDefinition[] | null;
+}
+
 export class ModuleInstance<StateType extends StateBaseType> {
     private _id: string;
     private _title: string;
@@ -38,21 +45,11 @@ export class ModuleInstance<StateType extends StateBaseType> {
     private _statusController: ModuleInstanceStatusControllerInternal;
     private _channelManager: ChannelManager;
 
-    constructor({
-        module,
-        instanceNumber,
-        channelDefinitions,
-        channelReceiverDefinitions,
-    }: {
-        module: Module<StateType>;
-        instanceNumber: number;
-        channelDefinitions: ChannelDefinition[] | null;
-        channelReceiverDefinitions: ChannelReceiverDefinition[] | null;
-    }) {
-        this._id = `${module.getName()}-${instanceNumber}`;
-        this._title = module.getDefaultTitle();
+    constructor(options: ModuleInstanceOptions<StateType>) {
+        this._id = `${options.module.getName()}-${options.instanceNumber}`;
+        this._title = options.module.getDefaultTitle();
         this._stateStore = null;
-        this._module = module;
+        this._module = options.module;
         this._importStateSubscribers = new Set();
         this._context = null;
         this._initialised = false;
@@ -68,17 +65,17 @@ export class ModuleInstance<StateType extends StateBaseType> {
 
         this._channelManager = new ChannelManager(this._id);
 
-        if (channelReceiverDefinitions) {
+        if (options.channelReceiverDefinitions) {
             this._channelManager.registerReceivers(
-                channelReceiverDefinitions.map((el) => ({
+                options.channelReceiverDefinitions.map((el) => ({
                     ...el,
                     supportsMultiContents: el.supportsMultiContents ?? false,
                 }))
             );
         }
 
-        if (channelDefinitions) {
-            this._channelManager.registerChannels(channelDefinitions);
+        if (options.channelDefinitions) {
+            this._channelManager.registerChannels(options.channelDefinitions);
         }
     }
 

diff --git a/frontend/src/framework/internal/DataChannels/ChannelReceiver.ts b/frontend/src/framework/internal/DataChannels/ChannelReceiver.ts
@@ -1,8 +1,8 @@
+import { KeyKind } from "@framework/DataChannelTypes";
+
 import { Channel, ChannelNotificationTopic } from "./Channel";
 import { ChannelManager } from "./ChannelManager";
 
-import { KeyKind } from "../../DataChannelTypes";
-
 export interface ChannelReceiverDefinition {
     readonly idString: string;
     readonly displayName: string;