From d41d61f48e60133775d52aa8224a96bc8ca015aa Mon Sep 17 00:00:00 2001
From: Andrew Bulat <andrii.bulat@gmail.com>
Date: Fri, 5 Jan 2024 20:59:45 +0000
Subject: [PATCH] Refactor IPlatformConfig

Splits IPlatformConfig into two separate interfaces for common required
and platform specific optional properties so it's more explicit where
a new property should be added.
---
 src/common/types/IPlatformConfig.d.ts | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/src/common/types/IPlatformConfig.d.ts b/src/common/types/IPlatformConfig.d.ts
index 9d678f23bb..d6fb7447b4 100644
--- a/src/common/types/IPlatformConfig.d.ts
+++ b/src/common/types/IPlatformConfig.d.ts
@@ -1,4 +1,9 @@
-export interface IPlatformConfig {
+/**
+ * Interface for common config properties shared between all platforms and that are relevant for all platforms.
+ *
+ * These properties must always be required and set for each platform.
+ */
+export interface ICommonPlatformConfig {
   agent: string;
   logTimestamps: boolean;
   binaryType: BinaryType;
@@ -9,6 +14,14 @@ export interface IPlatformConfig {
   nextTick: process.nextTick;
   inspect: (value: unknown) => string;
   stringByteSize: Buffer.byteLength;
+}
+
+/**
+ * Interface for platform specific config properties that do make sense on some platforms but not on others.
+ *
+ * These properties should always be optional, so that only relevant platforms would set them.
+ */
+export interface ISpecificPlatformConfig {
   addEventListener?: typeof window.addEventListener | typeof global.addEventListener | null;
   getRandomValues?: (arr: ArrayBufferView, callback?: (error: Error | null) => void) => void;
   userAgent?: string | null;
@@ -29,3 +42,5 @@ export interface IPlatformConfig {
   ) => void;
   isWebworker?: boolean;
 }
+
+export type IPlatformConfig = ICommonPlatformConfig & ISpecificPlatformConfig;