The MockerProxyRoute type does not work for strictNullChecks

[ikatyang]

Version: 2.3.0

Steps to reproduce:

mkdir mocker-api-repro-MockerProxyRoute-strictNullChecks
cd mocker-api-repro-MockerProxyRoute-strictNullChecks
npm init -y
npm install typescript mocker-api
echo '{"compilerOptions":{"strictNullChecks":true,"allowSyntheticDefaultImports":true}}' > tsconfig.json
echo 'import {} from "mocker-api"' > index.ts
npx tsc

node_modules/mocker-api/lib/index.d.ts:36:5 - error TS2411: Property '_proxy' of type 'MockerOption | undefined' is not assignable to string index type 'MockerResult'.

36     _proxy?: MockerOption;
       ~~~~~~


Found 1 error.

[jaywcjlove]

@ikatyang Reference example.

[ikatyang]

#125 (comment) can also reproduce the issue here.

[ikatyang]

Here's the patch I used to workaround this issue:

diff --git a/lib/index.d.ts b/lib/index.d.ts
index 2edca13a3814452a8170cb9cc0f856dd0d65553b..4511678106ca1111d9836f816012c76db8f4ab17 100644
--- a/lib/index.d.ts
+++ b/lib/index.d.ts
@@ -26,7 +26,7 @@ export declare type MockerResult = string | number | Array<any> | Record<string,
  * }
  * ```
  */
-export interface MockerProxyRoute extends Record<string, MockerResult> {
+export type MockerProxyRoute = Record<string, MockerResult> & {
     /**
      * This is the option parameter setting for apiMocker
      * Priority processing.
      * apiMocker(app, path, option)
      * {@link MockerOption}
      */
     _proxy?: MockerOption;
 }

[jaywcjlove]

@ikatyang Change the interface to type?

[ikatyang]

Yes, the issue here is that undefined | MockerOption does not satisfy its index signature MockerResult, using intersection type can bypass this limitation.

[jaywcjlove]

@ikatyang Upgrade + [email protected]

[ikatyang]

Thank you!