search

sindresorhus / ow

Function argument validation for humans
https://sindresorhus.com/ow/
MIT License
3.8k stars 105 forks source link

Documentation bug? #180

Closed rauschma closed 3 years ago

rauschma commented 4 years ago

https://sindresorhus.com/ow/classes/arraypredicate.html#deepequal

Documentation:

deepEqual(expected: keyof T[]): this

Source code:

deepEqual(expected: readonly T[]) {...}

The source code is what I’d expect. keyof T[] seems wrong in this context.

sindresorhus commented 4 years ago

This looks like a bug in TypeDoc, the thing we use to auto-generate the docs. I'll open an issue over there when I have some time.

sindresorhus commented 3 years ago

Fixed: https://sindresorhus.com/ow/classes/arraypredicate.html#deepequal