$ReadOnly<T> has a typo in its documentation

[cyli2014]

Description

The documentation for $ReadOnly<T> seems to have a typo.

import { $ReadOnly } from 'utility-types';

type Props = { name: string; age: number; visible: boolean };

// Expect: Readonly<{ name: string; age?: number | undefined; visible: boolean; }>
type ReadOnlyProps = $ReadOnly<Props>;

The example shows that age is converted to an optional property after being applied $ReadOnly. I thinks it's a typo because age should be an ordinary readonly property just like name and visible.

Steps to Reproduce

1. Refer to $ReadOnly in README.md

Expected Behavior

import { $ReadOnly } from 'utility-types';

type Props = { name: string; age: number; visible: boolean };

// Expect: Readonly<{ name: string; age: number; visible: boolean; }>
type ReadOnlyProps = $ReadOnly<Props>;

Suggested Solution(s)

Modify the documentation in README.md and comments in utility-types.ts

Project Dependencies

• Utility-Types Version: 3.10.0

Environment (optional)

• Browser and Version: XXX
• OS: XXX
• Node Version: XXX
• Package Manager and Version: XXX

[cyli2014]

BTW, some npm scripts don't work well on Windows. Any plan for compatibility?

[piotrwitek]

You're right, thanks for the fix!

I'm not using windows so I cannot help, but if you can add Windows compatibility it would be great!

[cyli2014]

Gotcha. Will look into it if time permits. Thanks!