fix: ReadOnly<T> has a typo in its documentation (#156) (#157)

piotrwitek · Oct 25, 2020 · df2502e · df2502e
1 parent ff848f2
commit df2502e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -975,7 +975,7 @@ import { $ReadOnly } from 'utility-types';
 
 type Props = { name: string; age: number; visible: boolean };
 
-// Expect: Readonly<{ name: string; age?: number | undefined; visible: boolean; }>
+// Expect: Readonly<{ name: string; age: number; visible: boolean; }>
 type ReadOnlyProps = $ReadOnly<Props>;
 ```
 

diff --git a/src/utility-types.ts b/src/utility-types.ts
@@ -31,7 +31,7 @@ export type $Values<T extends object> = T[keyof T];
  * @example
  *   type Props = { name: string; age: number; visible: boolean };
  *
- *   // Expect: Readonly<{ name: string; age?: number | undefined; visible: boolean; }>
+ *   // Expect: Readonly<{ name: string; age: number; visible: boolean; }>
  *   type ReadOnlyProps = $ReadOnly<Props>;
  */
 export type $ReadOnly<T extends object> = DeepReadonly<T>;