increase branch coverage

index.d.ts

@@ -1,10 +1,14 @@
 import { type PaperType } from './paperSpecifications.js';
 import type { PaperSizeUnit, PaperSpecifications } from './types.js';
-export declare function isPaperType(possiblePaperType: string): possiblePaperType is PaperType;
+export declare function isPaperType(possiblePaperType?: string): possiblePaperType is PaperType;
 export declare function getPaperSize(paperType: PaperType, paperSizeUnit?: PaperSizeUnit): PaperSpecifications;
 export declare function getPaperSize(paperType: Omit<string, PaperType>, paperSizeUnit?: PaperSizeUnit): undefined;
+export declare function getPaperSize(paperType: PaperType, paperSizeUnit?: Omit<string, PaperSizeUnit>): undefined;
+export declare function getPaperSize(paperType: Omit<string, PaperType>, paperSizeUnit?: Omit<string, PaperSizeUnit>): undefined;
 export declare function getLandscapePaperSize(paperType: PaperType, paperSizeUnit?: PaperSizeUnit): PaperSpecifications;
 export declare function getLandscapePaperSize(paperType: Omit<string, PaperType>, paperSizeUnit?: PaperSizeUnit): undefined;
+export declare function getLandscapePaperSize(paperType: PaperType, paperSizeUnit?: Omit<string, PaperSizeUnit>): undefined;
+export declare function getLandscapePaperSize(paperType: Omit<string, PaperType>, paperSizeUnit?: Omit<string, PaperSizeUnit>): undefined;
 export declare function getPaperSizeInInches(paperType: PaperType): PaperSpecifications;
 export declare function getPaperSizeInInches(paperType: Omit<string, PaperType>): undefined;
 export declare function getPaperSizeInMillimetres(paperType: PaperType): PaperSpecifications;

index.js

@@ -1,7 +1,7 @@
 import { paperSpecifications } from './paperSpecifications.js';
 const mmToInches = 25.4;
-export function isPaperType(possiblePaperType) {
-    return Object.hasOwn(paperSpecifications, (possiblePaperType ?? '').toUpperCase());
+export function isPaperType(possiblePaperType = '') {
+    return Object.hasOwn(paperSpecifications, possiblePaperType.toUpperCase());
 }
 export function getPaperSize(paperType, paperSizeUnit) {
     const specifications = paperSpecifications[(paperType ?? '').toUpperCase()];

index.ts

@@ -9,12 +9,9 @@ const mmToInches = 25.4
  * @returns True if the string represents a known paper type.
  */
 export function isPaperType(
-  possiblePaperType: string
+  possiblePaperType = ''
 ): possiblePaperType is PaperType {
-  return Object.hasOwn(
-    paperSpecifications,
-    (possiblePaperType ?? '').toUpperCase()
-  )
+  return Object.hasOwn(paperSpecifications, possiblePaperType.toUpperCase())
 }
 
 export function getPaperSize(
@@ -27,6 +24,16 @@ export function getPaperSize(
   paperSizeUnit?: PaperSizeUnit
 ): undefined
 
+export function getPaperSize(
+  paperType: PaperType,
+  paperSizeUnit?: Omit<string, PaperSizeUnit>
+): undefined
+
+export function getPaperSize(
+  paperType: Omit<string, PaperType>,
+  paperSizeUnit?: Omit<string, PaperSizeUnit>
+): undefined
+
 /**
  * Retrieves the portrait paper dimensions.
  * When the paperSizeUnit is undefined, the specified units are returned.
@@ -40,7 +47,9 @@ export function getPaperSize(
   paperType: string,
   paperSizeUnit?: PaperSizeUnit
 ): PaperSpecifications | undefined {
-  const specifications = paperSpecifications[(paperType ?? '').toUpperCase()]
+  const specifications = paperSpecifications[
+    (paperType ?? '').toUpperCase()
+  ] as PaperSpecifications | undefined
 
   if (
     specifications === undefined ||
@@ -81,6 +90,16 @@ export function getLandscapePaperSize(
   paperSizeUnit?: PaperSizeUnit
 ): undefined
 
+export function getLandscapePaperSize(
+  paperType: PaperType,
+  paperSizeUnit?: Omit<string, PaperSizeUnit>
+): undefined
+
+export function getLandscapePaperSize(
+  paperType: Omit<string, PaperType>,
+  paperSizeUnit?: Omit<string, PaperSizeUnit>
+): undefined
+
 /**
  * Retrieves the landscape paper dimensions.
  * When the paperSizeUnit is undefined, the specified units are returned.

paperSpecifications/iso.d.ts

@@ -339,4 +339,4 @@ export declare const isoPaperSpecifications: Readonly<Readonly<{
     };
 }>>;
 export type IsoPaperType = keyof typeof isoPaperSpecifications | Lowercase<keyof typeof isoPaperSpecifications>;
-export declare function isIsoPaperType(possiblePaperType: string): possiblePaperType is IsoPaperType;
+export declare function isIsoPaperType(possiblePaperType?: string): possiblePaperType is IsoPaperType;

paperSpecifications/iso.js

@@ -38,6 +38,6 @@ export const cSeriesPaperSpecifications = Object.freeze({
     C10: { width: 28, height: 40, unit: 'mm' }
 });
 export const isoPaperSpecifications = Object.freeze(Object.assign({}, aSeriesPaperSpecifications, bSeriesPaperSpecifications, cSeriesPaperSpecifications));
-export function isIsoPaperType(possiblePaperType) {
-    return Object.hasOwn(isoPaperSpecifications, (possiblePaperType ?? '').toUpperCase());
+export function isIsoPaperType(possiblePaperType = '') {
+    return Object.hasOwn(isoPaperSpecifications, possiblePaperType.toUpperCase());
 }

paperSpecifications/iso.ts

@@ -61,10 +61,7 @@ export type IsoPaperType =
  * @returns True if the string represents a known ISO paper type.
  */
 export function isIsoPaperType(
-  possiblePaperType: string
+  possiblePaperType = ''
 ): possiblePaperType is IsoPaperType {
-  return Object.hasOwn(
-    isoPaperSpecifications,
-    (possiblePaperType ?? '').toUpperCase()
-  )
+  return Object.hasOwn(isoPaperSpecifications, possiblePaperType.toUpperCase())
 }

paperSpecifications/northAmerica.d.ts

@@ -140,4 +140,4 @@ export declare const northAmericanPaperSpecifications: Readonly<Readonly<{
     };
 }>>;
 export type NorthAmericanPaperType = keyof typeof northAmericanPaperSpecifications | Lowercase<keyof typeof northAmericanPaperSpecifications> | Capitalize<Lowercase<keyof typeof northAmericanPaperSpecifications>>;
-export declare function isNorthAmericanPaperType(possiblePaperType: string): possiblePaperType is NorthAmericanPaperType;
+export declare function isNorthAmericanPaperType(possiblePaperType?: string): possiblePaperType is NorthAmericanPaperType;

paperSpecifications/northAmerica.js

@@ -36,6 +36,6 @@ export const archPaperSpecifications = Object.freeze({
     'ARCH E3': { width: 27, height: 39, unit: 'in' }
 });
 export const northAmericanPaperSpecifications = Object.freeze(Object.assign({}, commonNorthAmericanPaperSpecifications, ansiPaperSpecifications, archPaperSpecifications));
-export function isNorthAmericanPaperType(possiblePaperType) {
-    return Object.hasOwn(northAmericanPaperSpecifications, (possiblePaperType ?? '').toUpperCase());
+export function isNorthAmericanPaperType(possiblePaperType = '') {
+    return Object.hasOwn(northAmericanPaperSpecifications, possiblePaperType.toUpperCase());
 }

paperSpecifications/northAmerica.ts

@@ -65,10 +65,10 @@ export type NorthAmericanPaperType =
  * @returns True if the string represents a known ISO paper type.
  */
 export function isNorthAmericanPaperType(
-  possiblePaperType: string
+  possiblePaperType = ''
 ): possiblePaperType is NorthAmericanPaperType {
   return Object.hasOwn(
     northAmericanPaperSpecifications,
-    (possiblePaperType ?? '').toUpperCase()
+    possiblePaperType.toUpperCase()
   )
 }

test/test.js

@@ -1,14 +1,14 @@
 import assert from 'node:assert';
 import { describe, it } from 'node:test';
-import { getLandscapePaperSize, getPaperSize, getPaperSizeInInches, getPaperSizeInMillimetres, isIsoPaperType, isNorthAmericanPaperType, paperSpecifications } from '../index.js';
+import { getLandscapePaperSize, getPaperSize, getPaperSizeInInches, getPaperSizeInMillimetres, isIsoPaperType, isNorthAmericanPaperType, isPaperType, paperSpecifications } from '../index.js';
 await describe('@cityssm/paper-sizes', async () => {
     const paperTypes = Object.keys(paperSpecifications);
     for (const paperType of paperTypes) {
         await describe(`Paper type: ${paperType}`, async () => {
-            await it('Defined with an upper case key', async () => {
+            await it('Defined with an upper case key', () => {
                 assert.strictEqual(paperType, paperType.toUpperCase());
             });
-            await it('Returns portrait paper dimensions', async () => {
+            await it('Returns portrait paper dimensions', () => {
                 const portrait = getPaperSize(paperType);
                 console.log(`${paperType}: ${JSON.stringify(portrait)}`);
                 assert(portrait);
@@ -20,7 +20,7 @@ await describe('@cityssm/paper-sizes', async () => {
                     assert.strictEqual(portrait.unit, 'in');
                 }
             });
-            await it('Returns landscape paper dimensions', async () => {
+            await it('Returns landscape paper dimensions', () => {
                 const landscape = getLandscapePaperSize(paperType.toUpperCase());
                 assert(landscape);
                 assert(landscape.width >= landscape.height);
@@ -31,23 +31,32 @@ await describe('@cityssm/paper-sizes', async () => {
                     assert.strictEqual(landscape.unit, 'in');
                 }
             });
-            await it('Returns paper dimensions in inches', async () => {
+            await it('Returns paper dimensions in inches', () => {
                 const portrait = getPaperSizeInInches(paperType.toLowerCase());
                 assert(portrait);
                 assert.strictEqual(portrait.unit, 'in');
             });
-            await it('Returns paper dimensions in millimetres', async () => {
+            await it('Returns paper dimensions in millimetres', () => {
                 const portrait = getPaperSizeInMillimetres(paperType);
                 assert(portrait);
                 assert.strictEqual(portrait.unit, 'mm');
             });
         });
     }
     await describe('Error handling', async () => {
-        await it('Returns undefined when the size unit is unknown', async () => {
-            assert.strictEqual(getPaperSize('Letter', 'bananas'), undefined);
+        await it('Returns false for unknown paper types', () => {
+            const invalidPaperType = 'invalidPaperType';
+            assert.strictEqual(isPaperType(invalidPaperType), false);
+            assert.strictEqual(isNorthAmericanPaperType(invalidPaperType), false);
+            assert.strictEqual(isIsoPaperType(invalidPaperType), false);
+            assert.strictEqual(isPaperType(undefined), false);
         });
-        await it('Returns undefined when the paper type is unknown', async () => {
+        await it('Returns undefined when the size unit is unknown', () => {
+            const invalidUnit = 'bananas';
+            assert.strictEqual(getPaperSize('Letter', invalidUnit), undefined);
+            assert.strictEqual(getLandscapePaperSize('Letter', invalidUnit), undefined);
+        });
+        await it('Returns undefined when the paper type is unknown', () => {
             const unknownPaperType = 'unknown';
             assert.strictEqual(getPaperSize(unknownPaperType), undefined);
             assert.strictEqual(getLandscapePaperSize(unknownPaperType), undefined);

test/test.ts

@@ -1,3 +1,6 @@
+// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
+
 import assert from 'node:assert'
 import { describe, it } from 'node:test'
 
@@ -9,19 +12,21 @@ import {
   getPaperSizeInMillimetres,
   isIsoPaperType,
   isNorthAmericanPaperType,
+  isPaperType,
   paperSpecifications
 } from '../index.js'
 
 await describe('@cityssm/paper-sizes', async () => {
   const paperTypes = Object.keys(paperSpecifications) as PaperType[]
 
   for (const paperType of paperTypes) {
+    // eslint-disable-next-line @typescript-eslint/no-loop-func
     await describe(`Paper type: ${paperType}`, async () => {
-      await it('Defined with an upper case key', async () => {
+      await it('Defined with an upper case key', () => {
         assert.strictEqual(paperType, paperType.toUpperCase())
       })
 
-      await it('Returns portrait paper dimensions', async () => {
+      await it('Returns portrait paper dimensions', () => {
         const portrait = getPaperSize(paperType)
         console.log(`${paperType}: ${JSON.stringify(portrait)}`)
 
@@ -37,7 +42,7 @@ await describe('@cityssm/paper-sizes', async () => {
         }
       })
 
-      await it('Returns landscape paper dimensions', async () => {
+      await it('Returns landscape paper dimensions', () => {
         const landscape = getLandscapePaperSize(
           paperType.toUpperCase() as PaperType
         )
@@ -54,15 +59,15 @@ await describe('@cityssm/paper-sizes', async () => {
         }
       })
 
-      await it('Returns paper dimensions in inches', async () => {
+      await it('Returns paper dimensions in inches', () => {
         const portrait = getPaperSizeInInches(
           paperType.toLowerCase() as PaperType
         )
         assert(portrait)
         assert.strictEqual(portrait.unit, 'in')
       })
 
-      await it('Returns paper dimensions in millimetres', async () => {
+      await it('Returns paper dimensions in millimetres', () => {
         const portrait = getPaperSizeInMillimetres(paperType)
         assert(portrait)
         assert.strictEqual(portrait.unit, 'mm')
@@ -71,23 +76,34 @@ await describe('@cityssm/paper-sizes', async () => {
   }
 
   await describe('Error handling', async () => {
-    await it('Returns undefined when the size unit is unknown', async() => {
-      assert.strictEqual(getPaperSize('Letter', 'bananas'), undefined)
+    await it('Returns false for unknown paper types', () => {
+      const invalidPaperType = 'invalidPaperType'
+
+      assert.strictEqual(isPaperType(invalidPaperType), false)
+      assert.strictEqual(isNorthAmericanPaperType(invalidPaperType), false)
+      assert.strictEqual(isIsoPaperType(invalidPaperType), false)
+
+      // eslint-disable-next-line unicorn/no-useless-undefined
+      assert.strictEqual(isPaperType(undefined), false)
+    })
+
+    await it('Returns undefined when the size unit is unknown', () => {
+      const invalidUnit = 'bananas'
+
+      assert.strictEqual(getPaperSize('Letter', invalidUnit), undefined)
+      assert.strictEqual(
+        getLandscapePaperSize('Letter', invalidUnit),
+        undefined
+      )
     })
 
-    await it('Returns undefined when the paper type is unknown', async () => {
+    await it('Returns undefined when the paper type is unknown', () => {
       const unknownPaperType = 'unknown'
 
-      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
       assert.strictEqual(getPaperSize(unknownPaperType), undefined)
-
-      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
       assert.strictEqual(getLandscapePaperSize(unknownPaperType), undefined)
 
-      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
       assert.strictEqual(getPaperSizeInInches(unknownPaperType), undefined)
-
-      // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
       assert.strictEqual(getPaperSizeInMillimetres(unknownPaperType), undefined)
     })
   })