orbit-oss/is
5
5
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: clarify

Browse source
This commit is contained in:
PopGoesTheWza 2021-09-09 22:06:17 +02:00
parent d0071ffe6e
commit b7bb76d96c
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/index.ts
View file

@ -361,7 +361,7 @@ is.emptyMap = (value: unknown): value is Map<never, never> => is.map(value) && v
is.nonEmptyMap = <Key = unknown, Value = unknown>(value: unknown): value is Map<Key, Value> => is.map(value) && value.size > 0;
/**
Returns `true` if `value` can be used as an object property key (either a `string`, a `number` or a `symbol`).
`PropertyKey` is any value that can be used as an object key (string, number, or symbol)
*/
is.propertyKey = (value: unknown): value is PropertyKey => is.any([is.string, is.number, is.symbol], value);