fix: replaced NoData type with ObjectEmpty

[ci skip]

Author: tegefaulkes

src/agent/types.ts

@@ -1,26 +1,25 @@
-import type { JSONValue } from '../types';
-
-// eslint-disable-next-line
-type NoData = {};
+import type { JSONValue, ObjectEmpty } from '../types';
 
 // Prevent overwriting the metadata type with `Omit<>`
-type AgentRPCRequestParams<T extends Record<string, JSONValue> = NoData> = {
-  metadata?: {
-    [Key: string]: JSONValue;
-  } & Partial<{
-    authorization: string;
-    timeout: number;
-  }>;
-} & Omit<T, 'metadata'>;
+type AgentRPCRequestParams<T extends Record<string, JSONValue> = ObjectEmpty> =
+  {
+    metadata?: {
+      [Key: string]: JSONValue;
+    } & Partial<{
+      authorization: string;
+      timeout: number;
+    }>;
+  } & Omit<T, 'metadata'>;
 
 // Prevent overwriting the metadata type with `Omit<>`
-type AgentRPCResponseResult<T extends Record<string, JSONValue> = NoData> = {
-  metadata?: {
-    [Key: string]: JSONValue;
-  } & Partial<{
-    authorization: string;
-    timeout: number;
-  }>;
-} & Omit<T, 'metadata'>;
+type AgentRPCResponseResult<T extends Record<string, JSONValue> = ObjectEmpty> =
+  {
+    metadata?: {
+      [Key: string]: JSONValue;
+    } & Partial<{
+      authorization: string;
+      timeout: number;
+    }>;
+  } & Omit<T, 'metadata'>;
 
-export type { AgentRPCRequestParams, AgentRPCResponseResult, NoData };
+export type { AgentRPCRequestParams, AgentRPCResponseResult };

src/client/types.ts

@@ -1,20 +1,20 @@
-import type { JSONValue } from '../types';
-
-// eslint-disable-next-line
-type NoData = {};
+import type { JSONValue, ObjectEmpty } from '../types';
 
 // Prevent overwriting the metadata type with `Omit<>`
-type ClientRPCRequestParams<T extends Record<string, JSONValue> = NoData> = {
-  metadata?: {
-    [Key: string]: JSONValue;
-  } & Partial<{
-    authorization: string;
-    timeout: number;
-  }>;
-} & Omit<T, 'metadata'>;
+type ClientRPCRequestParams<T extends Record<string, JSONValue> = ObjectEmpty> =
+  {
+    metadata?: {
+      [Key: string]: JSONValue;
+    } & Partial<{
+      authorization: string;
+      timeout: number;
+    }>;
+  } & Omit<T, 'metadata'>;
 
 // Prevent overwriting the metadata type with `Omit<>`
-type ClientRPCResponseResult<T extends Record<string, JSONValue> = NoData> = {
+type ClientRPCResponseResult<
+  T extends Record<string, JSONValue> = ObjectEmpty,
+> = {
   metadata?: {
     [Key: string]: JSONValue;
   } & Partial<{
@@ -23,4 +23,4 @@ type ClientRPCResponseResult<T extends Record<string, JSONValue> = NoData> = {
   }>;
 } & Omit<T, 'metadata'>;
 
-export type { ClientRPCRequestParams, ClientRPCResponseResult, NoData };
+export type { ClientRPCRequestParams, ClientRPCResponseResult };

src/types.ts

@@ -151,6 +151,13 @@ type InverseRecord<
   [K in M[keyof M]]: RecordKeyFromValue<M, K>;
 };
 
+/**
+ * Used when an empty object is needed.
+ * Defined here with a linter override to avoid a false positive.
+ */
+// eslint-disable-next-line
+type ObjectEmpty = {};
+
 export type {
   POJO,
   JSONValue,
@@ -171,4 +178,5 @@ export type {
   NonFunctionProperties,
   RecordKeyFromValue,
   InverseRecord,
+  ObjectEmpty,
 };