241680642

Build Type

github

Committed by GitHub

Commit Message

Merge 75be1c919 into 07906f0ce

Pull Request Pull Request #8: refactor: redesign internal types

Run Details

213 of 222 branches covered (95.95%)

Branch coverage included in aggregate %.

194 of 199 new or added lines in 24 files covered. (97.49%)

1 existing line in 1 file now uncovered.

387 of 393 relevant lines covered (98.47%)

2021.62 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.77

/src/types/array.ts

import { Static, create, innerValidate, RuntypeBase, Runtype } from '../runtype';

export interface ReadonlyArray<E extends RuntypeBase<unknown> = RuntypeBase<unknown>>
  extends Runtype<readonly Static<E>[]> {
  readonly tag: 'array';
  readonly element: E;
  readonly isReadonly: true;
}

export { Arr as Array };
interface Arr<E extends RuntypeBase<unknown> = RuntypeBase<unknown>> extends Runtype<Static<E>[]> {
  readonly tag: 'array';
  readonly element: E;
  readonly isReadonly: false;
  asReadonly(): ReadonlyArray<E>;
}

/**
 * Construct an array runtype from a runtype for its elements.
 */
function InternalArr<TElement extends RuntypeBase<unknown>, IsReadonly extends boolean>(
  element: TElement,
  isReadonly: IsReadonly,
): IsReadonly extends true ? ReadonlyArray<TElement> : Arr<TElement> {
  const result = create<ReadonlyArray<TElement> | Arr<TElement>>(
    (xs, visited) => {
      if (!Array.isArray(xs)) {
        return {
          success: false,
          message: `Expected array, but was ${xs === null ? xs : typeof xs}`,
        };
      }

      for (const x of xs) {
        let validated = innerValidate(element, x, visited);
        if (!validated.success) {
          return {
            success: false,
            message: validated.message,
            key: validated.key ? `[${xs.indexOf(x)}].${validated.key}` : `[${xs.indexOf(x)}]`,
          };
        }
      }

      return { success: true, value: xs };
    },
    {
      tag: 'array',
      isReadonly,
      element,
      show({ showChild }) {
        return `${isReadonly ? 'readonly ' : ''}${showChild(element, true)}[]`;
      },
    },
  );
  if (!isReadonly) {
    (result as any).asReadonly = asReadonly;
  }
  return result as any;
  function asReadonly(): ReadonlyArray<TElement> {
    return InternalArr(element, true);
  }
}

function Arr<TElement extends RuntypeBase<unknown>>(element: TElement): Arr<TElement> {
  return InternalArr(element, false);
}
export function ReadonlyArray<TElement extends RuntypeBase<unknown>>(
  element: TElement,
): ReadonlyArray<TElement> {
  return InternalArr(element, true);
}

1	import { Static, create, innerValidate, RuntypeBase, Runtype } from '../runtype';	36✔
2
3	export interface ReadonlyArray<E extends RuntypeBase<unknown> = RuntypeBase<unknown>>
4	extends Runtype<readonly Static<E>[]> {
5	readonly tag: 'array';
6	readonly element: E;
7	readonly isReadonly: true;
8	}
9
10	export { Arr as Array };	36✔
11	interface Arr<E extends RuntypeBase<unknown> = RuntypeBase<unknown>> extends Runtype<Static<E>[]> {
12	readonly tag: 'array';
13	readonly element: E;
14	readonly isReadonly: false;
15	asReadonly(): ReadonlyArray<E>;
16	}
17
18	/**
19	* Construct an array runtype from a runtype for its elements.
20	*/
21	function InternalArr<TElement extends RuntypeBase<unknown>, IsReadonly extends boolean>(
22	element: TElement,
23	isReadonly: IsReadonly,
24	): IsReadonly extends true ? ReadonlyArray<TElement> : Arr<TElement> {
25	const result = create<ReadonlyArray<TElement> \| Arr<TElement>>(	1,416✔
26	(xs, visited) => {
27	if (!Array.isArray(xs)) {	3,900✔
28	return {	2,856✔
29	success: false,
30	message: `Expected array, but was ${xs === null ? xs : typeof xs}`,	2,856✔
31	};
32	}
33
34	for (const x of xs) {	2,088✔
35	let validated = innerValidate(element, x, visited);	1,572✔
36	if (!validated.success) {	1,572✔
37	return {	576✔
38	success: false,
39	message: validated.message,
40	key: validated.key ? `[${xs.indexOf(x)}].${validated.key}` : `[${xs.indexOf(x)}]`,	576✔
41	};
42	}
43	}
44
45	return { success: true, value: xs };	468✔
46	},
47	{
48	tag: 'array',
49	isReadonly,
50	element,
51	show({ showChild }) {	312✔
52	return `${isReadonly ? 'readonly ' : ''}${showChild(element, true)}[]`;	312✔
53	},
54	},
55	);
56	if (!isReadonly) {	1,416✔
57	(result as any).asReadonly = asReadonly;	1,350✔
58	}
59	return result as any;	1,416✔
60	function asReadonly(): ReadonlyArray<TElement> {
61	return InternalArr(element, true);	66✔
62	}
63	}
64
65	function Arr<TElement extends RuntypeBase<unknown>>(element: TElement): Arr<TElement> {
66	return InternalArr(element, false);	1,350✔
67	}
68	export function ReadonlyArray<TElement extends RuntypeBase<unknown>>(	36✔
69	element: TElement,
70	): ReadonlyArray<TElement> {
NEW 71	return InternalArr(element, true);	×
72	}

ForbesLindesay / funtypes / 241680642

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous