docs(compat): predicate should have optional parameter (#880)

toss · Dec 8, 2024 · 8db96e4 · 8db96e4
1 parent 69c4274
commit 8db96e4
Show file tree

Hide file tree

Showing 35 changed files with 37 additions and 37 deletions.
diff --git a/docs/ja/reference/compat/predicate/isArrayLike.md b/docs/ja/reference/compat/predicate/isArrayLike.md
@@ -15,7 +15,7 @@ TypeScript の型ガードとして使用できます。パラメータとして
 ## インターフェース
 
 ```typescript
-function isArrayLike(value: unknown): value is ArrayLike<unknown>;
+function isArrayLike(value?: unknown): value is ArrayLike<unknown>;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isArrayLikeObject.md b/docs/ja/reference/compat/predicate/isArrayLikeObject.md
@@ -15,7 +15,7 @@ TypeScript の型ガードとして使用できます。パラメータとして
 ## インターフェース
 
 ```typescript
-function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+function isArrayLikeObject(value?: unknown): value is ArrayLike<unknown> & object;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isElement.md b/docs/ja/reference/compat/predicate/isElement.md
@@ -11,7 +11,7 @@
 ## インターフェース
 
 ```typescript
-function isElement(value: any): boolean;
+function isElement(value?: any): boolean;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isFinite.md b/docs/ja/reference/compat/predicate/isFinite.md
@@ -13,7 +13,7 @@
 ## インターフェース
 
 ```typescript
-function isFinite(value: unknown): value is number;
+function isFinite(value?: unknown): value is number;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isNaN.md b/docs/ja/reference/compat/predicate/isNaN.md
@@ -11,7 +11,7 @@
 ## インターフェース
 
 ```typescript
-function isNaN(value: unknown): value is typeof NaN;
+function isNaN(value?: unknown): value is typeof NaN;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isObject.md b/docs/ja/reference/compat/predicate/isObject.md
@@ -16,7 +16,7 @@
 ## インターフェース
 
 ```typescript
-function isObject(value: unknown): value is object;
+function isObject(value?: unknown): value is object;
 ```
 
 ### パラメータ

diff --git a/docs/ja/reference/compat/predicate/isObjectLike.md b/docs/ja/reference/compat/predicate/isObjectLike.md
@@ -15,12 +15,12 @@ TypeScript の型ガードとして使用できます。パラメータとして
 ## インターフェース
 
 ```typescript
-export function isObjectLike(value: unknown): value is object;
+export function isObjectLike(value?: unknown): value is object;
 ```
 
 ### パラメータ
 
-- `value` (`T`): オブジェクトのようであるかを確認する値です。
+- `value` (`unknown`): オブジェクトのようであるかを確認する値です。
 
 ### 戻り値
 

diff --git a/docs/ko/reference/compat/predicate/isArrayLike.md b/docs/ko/reference/compat/predicate/isArrayLike.md
@@ -15,7 +15,7 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-function isArrayLike(value: unknown): value is ArrayLike<unknown>;
+function isArrayLike(value?: unknown): value is ArrayLike<unknown>;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isArrayLikeObject.md b/docs/ko/reference/compat/predicate/isArrayLikeObject.md
@@ -17,7 +17,7 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+function isArrayLikeObject(value?: unknown): value is ArrayLike<unknown> & object;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isElement.md b/docs/ko/reference/compat/predicate/isElement.md
@@ -11,7 +11,7 @@
 ## 인터페이스
 
 ```typescript
-function isElement(value: any): boolean;
+function isElement(value?: any): boolean;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isFinite.md b/docs/ko/reference/compat/predicate/isFinite.md
@@ -13,7 +13,7 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-function isFinite(value: unknown): value is number;
+function isFinite(value?: unknown): value is number;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isNaN.md b/docs/ko/reference/compat/predicate/isNaN.md
@@ -13,7 +13,7 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-function isNaN(value: unknown): value is typeof NaN;
+function isNaN(value?: unknown): value is typeof NaN;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isObject.md b/docs/ko/reference/compat/predicate/isObject.md
@@ -15,7 +15,7 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-function isObject(value: unknown): value is object;
+function isObject(value?: unknown): value is object;
 ```
 
 ### 파라미터

diff --git a/docs/ko/reference/compat/predicate/isObjectLike.md b/docs/ko/reference/compat/predicate/isObjectLike.md
@@ -15,12 +15,12 @@ TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어
 ## 인터페이스
 
 ```typescript
-export function isObjectLike(value: unknown): value is object;
+export function isObjectLike(value?: unknown): value is object;
 ```
 
 ### 파라미터
 
-- `value` (`T`): 객체 같은지 확인할 값이에요.
+- `value` (`unknown`): 객체 같은지 확인할 값이에요.
 
 ### 반환 값
 

diff --git a/docs/reference/compat/predicate/isArrayLike.md b/docs/reference/compat/predicate/isArrayLike.md
@@ -15,7 +15,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isArrayLike(value: unknown): value is ArrayLike<unknown>;
+function isArrayLike(value?: unknown): value is ArrayLike<unknown>;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isArrayLikeObject.md b/docs/reference/compat/predicate/isArrayLikeObject.md
@@ -15,7 +15,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+function isArrayLikeObject(value?: unknown): value is ArrayLike<unknown> & object;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isElement.md b/docs/reference/compat/predicate/isElement.md
@@ -10,7 +10,7 @@ Checks if `value` is likely a DOM element.
 ## Signature
 
 ```typescript
-function isElement(value: any): boolean;
+function isElement(value?: any): boolean;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isFinite.md b/docs/reference/compat/predicate/isFinite.md
@@ -13,7 +13,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isFinite(value: unknown): value is number;
+function isFinite(value?: unknown): value is number;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isNaN.md b/docs/reference/compat/predicate/isNaN.md
@@ -13,7 +13,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isNaN(value: unknown): value is typeof NaN;
+function isNaN(value?: unknown): value is typeof NaN;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isObject.md b/docs/reference/compat/predicate/isObject.md
@@ -16,7 +16,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isObject(value: unknown): value is object;
+function isObject(value?: unknown): value is object;
 ```
 
 ### Parameters

diff --git a/docs/reference/compat/predicate/isObjectLike.md b/docs/reference/compat/predicate/isObjectLike.md
@@ -15,7 +15,7 @@ This function can also serve as a type predicate in TypeScript, narrowing the ty
 ## Signature
 
 ```typescript
-function isObjectLike(value: unknown): value is object;
+function isObjectLike(value?: unknown): value is object;
 ```
 
 ### Parameters

diff --git a/docs/zh_hans/reference/compat/predicate/isArrayLike.md b/docs/zh_hans/reference/compat/predicate/isArrayLike.md
@@ -16,7 +16,7 @@
 ## 签名
 
 ```typescript
-function isArrayLike(value: unknown): value is ArrayLike<unknown>;
+function isArrayLike(value?: unknown): value is ArrayLike<unknown>;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isArrayLikeObject.md b/docs/zh_hans/reference/compat/predicate/isArrayLikeObject.md
@@ -17,7 +17,7 @@
 ## 签名
 
 ```typescript
-function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+function isArrayLikeObject(value?: unknown): value is ArrayLike<unknown> & object;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isElement.md b/docs/zh_hans/reference/compat/predicate/isElement.md
@@ -11,7 +11,7 @@
 ## 签名
 
 ```typescript
-function isElement(value: any): boolean;
+function isElement(value?: any): boolean;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isFinite.md b/docs/zh_hans/reference/compat/predicate/isFinite.md
@@ -15,7 +15,7 @@
 ## 签名
 
 ```typescript
-function isFinite(value: unknown): value is number;
+function isFinite(value?: unknown): value is number;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isNaN.md b/docs/zh_hans/reference/compat/predicate/isNaN.md
@@ -13,7 +13,7 @@
 ## 签名
 
 ```typescript
-function isNaN(value: unknown): value is typeof NaN;
+function isNaN(value?: unknown): value is typeof NaN;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isObject.md b/docs/zh_hans/reference/compat/predicate/isObject.md
@@ -15,7 +15,7 @@
 ## 签名
 
 ```typescript
-function isObject(value: unknown): value is object;
+function isObject(value?: unknown): value is object;
 ```
 
 ### 参数

diff --git a/docs/zh_hans/reference/compat/predicate/isObjectLike.md b/docs/zh_hans/reference/compat/predicate/isObjectLike.md
@@ -16,7 +16,7 @@
 ## 签名
 
 ```typescript
-function isObjectLike(value: unknown): value is object;
+function isObjectLike(value?: unknown): value is object;
 ```
 
 ### 参数

diff --git a/src/compat/predicate/isArrayLike.ts b/src/compat/predicate/isArrayLike.ts
@@ -14,6 +14,6 @@ import { isLength } from '../../predicate/isLength.ts';
  * isArrayLike(null); // false
  * isArrayLike(undefined); // false
  */
-export function isArrayLike(value: unknown): value is ArrayLike<unknown> {
+export function isArrayLike(value?: unknown): value is ArrayLike<unknown> {
   return value != null && typeof value !== 'function' && isLength((value as ArrayLike<unknown>).length);
 }
diff --git a/src/compat/predicate/isArrayLikeObject.ts b/src/compat/predicate/isArrayLikeObject.ts
@@ -13,6 +13,6 @@ import { isObjectLike } from './isObjectLike.ts';
  * isArrayLikeObject('abc'); // false
  * isArrayLikeObject(()=>{}); // false
  */
-export function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object {
+export function isArrayLikeObject(value?: unknown): value is ArrayLike<unknown> & object {
   return isObjectLike(value) && isArrayLike(value);
 }
diff --git a/src/compat/predicate/isElement.ts b/src/compat/predicate/isElement.ts
@@ -11,6 +11,6 @@ import { isPlainObject } from './isPlainObject';
  * console.log(isElement(document.body)); // true
  * console.log(isElement('<body>')); // false
  */
-export function isElement(value: any): boolean {
+export function isElement(value?: any): boolean {
   return isObjectLike(value) && (value as any).nodeType === 1 && !isPlainObject(value);
 }
diff --git a/src/compat/predicate/isFinite.ts b/src/compat/predicate/isFinite.ts
@@ -15,6 +15,6 @@
  * console.log(isFinite(value3)); // false
  * ```
  */
-export function isFinite(value: unknown): value is number {
+export function isFinite(value?: unknown): value is number {
   return Number.isFinite(value);
 }
diff --git a/src/compat/predicate/isNaN.ts b/src/compat/predicate/isNaN.ts
@@ -10,6 +10,6 @@
  * isNaN('NaN'); // false
  * isNaN(undefined); // false
  */
-export function isNaN(value: unknown): value is typeof NaN {
+export function isNaN(value?: unknown): value is typeof NaN {
   return Number.isNaN(value);
 }
diff --git a/src/compat/predicate/isObject.ts b/src/compat/predicate/isObject.ts
@@ -22,6 +22,6 @@
  * console.log(isObject(value4)); // false
  */
 
-export function isObject(value: unknown): value is object {
+export function isObject(value?: unknown): value is object {
   return value !== null && (typeof value === 'object' || typeof value === 'function');
 }
diff --git a/src/compat/predicate/isObjectLike.ts b/src/compat/predicate/isObjectLike.ts
@@ -23,6 +23,6 @@
  * console.log(isObjectLike(value5)); // false
  */
 
-export function isObjectLike(value: unknown): value is object {
+export function isObjectLike(value?: unknown): value is object {
   return typeof value === 'object' && value !== null;
 }