refactor: allow pass null into analyzeSignature

faker-js · Aug 5, 2022 · 73d0f03 · 73d0f03
1 parent bfcd710
commit 73d0f03
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 6 deletions.
diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts
@@ -78,7 +78,7 @@ function mdToHtml(md: string): string {
 
 export function analyzeSignature(
   signature: SignatureReflection,
-  moduleName: string,
+  moduleName: string | null,
   methodName: string
 ): Method {
   const parameters: MethodParameter[] = [];

diff --git a/test/scripts/apidoc/signature.spec.ts b/test/scripts/apidoc/signature.spec.ts
@@ -36,11 +36,7 @@ describe('signature', () => {
     it.each(Object.keys(expected).sort())('%s', (name) => {
       const method = methods[name];
       expect(method, `Method ${name} to be defined`).toBeDefined();
-      const actual = analyzeSignature(
-        method.signatures[0],
-        '' /* null */,
-        method.name
-      );
+      const actual = analyzeSignature(method.signatures[0], null, method.name);
       actuals[name] = actual;
 
       expect(prettyJson(actual)).toBe(prettyJson(expected[name]));