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

Document TypeScript naming limitation

Browse source 
Fixes #157
This commit is contained in:
Sindre Sorhus 2022-02-01 11:37:28 +07:00
parent c3d12667fd
commit 04ccf21dba
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
readme.md
View file

@ -17,8 +17,8 @@ For example, `is.string('🦄') //=> true`
## Install ## Install
``` ```sh
$ npm install @sindresorhus/is npm install @sindresorhus/is
``` ```
## Usage ## Usage
@ -82,6 +82,9 @@ All the below methods accept a value and returns a boolean for whether the value
##### .undefined(value) ##### .undefined(value)
##### .null(value) ##### .null(value)
**Note:** TypeScript users must use `.null_()` because of a TypeScript naming limitation.
##### .string(value) ##### .string(value)
##### .number(value) ##### .number(value)
@ -103,6 +106,9 @@ is.array(value, is.number); // Validate `value` is an array and all of its items
``` ```
##### .function(value) ##### .function(value)
**Note:** TypeScript users must use `.function_()` because of a TypeScript naming limitation.
##### .buffer(value) ##### .buffer(value)
##### .object(value) ##### .object(value)
@ -372,6 +378,8 @@ An object is plain if it's created by either `{}`, `new Object()`, or `Object.cr
Returns `true` for instances created by a class. Returns `true` for instances created by a class.
**Note:** TypeScript users must use `.class_()` because of a TypeScript naming limitation.
##### .typedArray(value) ##### .typedArray(value)
##### .arrayLike(value) ##### .arrayLike(value)