mirror of
https://github.com/toss/es-toolkit.git
synced 2024-11-28 03:34:26 +03:00
docs: Add docs for functions
This commit is contained in:
parent
d216470391
commit
92500e54da
33
docs/ja/reference/compat/function/defer.md
Normal file
33
docs/ja/reference/compat/function/defer.md
Normal file
@ -0,0 +1,33 @@
|
||||
# defer
|
||||
|
||||
::: info
|
||||
この関数は互換性のために `es-toolkit/compat` からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。
|
||||
|
||||
`es-toolkit/compat` からこの関数をインポートすると、[lodash と完全に同じように動作](../../../compatibility.md)します。
|
||||
:::
|
||||
|
||||
`func`を呼び出しを、現在のコールスタックがクリアされるまで遅延します。追加の引数は、呼び出されたときに`func`に提供されます。
|
||||
|
||||
## インターフェース
|
||||
|
||||
```typescript
|
||||
function defer<F extends (...args: any[]) => any>(func: F, ...args: Parameters<F>): number;
|
||||
```
|
||||
|
||||
### パラメータ
|
||||
|
||||
- `func` (`F`): 遅延する関数。
|
||||
- `args` (`Parameters<F>`): `func`を呼び出すための引数。
|
||||
|
||||
### 戻り値
|
||||
|
||||
(`number`): タイマーID。
|
||||
|
||||
## 例
|
||||
|
||||
```typescript
|
||||
defer((text) => {
|
||||
console.log(text);
|
||||
}, 'deferred');
|
||||
// => Logs 'deferred' after the current call stack has cleared.
|
||||
```
|
34
docs/ja/reference/compat/util/toFinite.md
Normal file
34
docs/ja/reference/compat/util/toFinite.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toFinite
|
||||
|
||||
::: info
|
||||
この関数は互換性のために `es-toolkit/compat` からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。
|
||||
|
||||
`es-toolkit/compat` からこの関数をインポートすると、[lodash と完全に同じように動作](../../../compatibility.md)します。
|
||||
:::
|
||||
|
||||
`value` を有限の数値に変換します。
|
||||
|
||||
## インターフェース
|
||||
|
||||
```typescript
|
||||
function toFinite(value?: unknown): number;
|
||||
```
|
||||
|
||||
### パラメータ
|
||||
|
||||
- `value` (`unknown`): 変換する値。
|
||||
|
||||
### 戻り値
|
||||
|
||||
(`number`): 有限の数値。
|
||||
|
||||
## 例
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => 1.7976931348623157e+308
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => 0
|
||||
toNumber(NaN); // => 0
|
||||
```
|
34
docs/ja/reference/compat/util/toInteger.md
Normal file
34
docs/ja/reference/compat/util/toInteger.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toInteger
|
||||
|
||||
::: info
|
||||
この関数は互換性のために `es-toolkit/compat` からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。
|
||||
|
||||
`es-toolkit/compat` からこの関数をインポートすると、[lodash と完全に同じように動作](../../../compatibility.md)します。
|
||||
:::
|
||||
|
||||
`value`を整数に変換します。無限大の値の場合は、有限の値に変換されます。小数点以下の数字は切り捨てられます。
|
||||
|
||||
## インターフェース
|
||||
|
||||
```typescript
|
||||
function toInteger(value?: unknown): number;
|
||||
```
|
||||
|
||||
### パラメータ
|
||||
|
||||
- `value` (`unknown`): 変換する値。
|
||||
|
||||
### 戻り値
|
||||
|
||||
(`number`): 整数。
|
||||
|
||||
## 例
|
||||
|
||||
```typescript
|
||||
toInteger(3.2); // => 3
|
||||
toInteger(Number.MIN_VALUE); // => 0
|
||||
toInteger(Infinity); // => 1.7976931348623157e+308
|
||||
toInteger('3.2'); // => 3
|
||||
toInteger(Symbol.iterator); // => 0
|
||||
toInteger(NaN); // => 0
|
||||
```
|
36
docs/ja/reference/compat/util/toNumber.md
Normal file
36
docs/ja/reference/compat/util/toNumber.md
Normal file
@ -0,0 +1,36 @@
|
||||
# toNumber
|
||||
|
||||
::: info
|
||||
この関数は互換性のために `es-toolkit/compat` からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。
|
||||
|
||||
`es-toolkit/compat` からこの関数をインポートすると、[lodash と完全に同じように動作](../../../compatibility.md)します。
|
||||
:::
|
||||
|
||||
`value`を数値に変換します。
|
||||
|
||||
`Number()`とは異なり、この関数はシンボルに対して`NaN`を返します。
|
||||
|
||||
## インターフェース
|
||||
|
||||
```typescript
|
||||
function toNumber(value?: unknown): number;
|
||||
```
|
||||
|
||||
### パラメータ
|
||||
|
||||
- `value` (`unknown`): 変換する値。
|
||||
|
||||
### 戻り値
|
||||
|
||||
(`number`): 変換された数値。
|
||||
|
||||
## 例
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => Infinity
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => NaN
|
||||
toNumber(NaN); // => NaN
|
||||
```
|
28
docs/ja/reference/string/constantCase.md
Normal file
28
docs/ja/reference/string/constantCase.md
Normal file
@ -0,0 +1,28 @@
|
||||
# constantCase
|
||||
|
||||
文字列を定数ケースに変換します。
|
||||
|
||||
定数ケースは、各単語が大文字で書かれ、アンダースコア(`_`)で区切られる命名規則です。たとえば、`CONSTANT_CASE`。
|
||||
|
||||
## インターフェース
|
||||
|
||||
```typescript
|
||||
function constantCase(str: string): string;
|
||||
```
|
||||
|
||||
### パラメータ
|
||||
|
||||
- `str` (`string`): 定数ケースに変更される文字列。
|
||||
|
||||
### 戻り値
|
||||
|
||||
(`string`): 定数ケースに変換された文字列。
|
||||
|
||||
## 例
|
||||
|
||||
```typescript
|
||||
const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'
|
||||
const convertedStr2 = constantCase('some whitespace') // returns 'SOME_WHITESPACE'
|
||||
const convertedStr3 = constantCase('hyphen-text') // returns 'HYPHEN_TEXT'
|
||||
const convertedStr4 = constantCase('HTTPRequest') // returns 'HTTP_REQUEST'
|
||||
```
|
33
docs/ko/reference/compat/function/defer.md
Normal file
33
docs/ko/reference/compat/function/defer.md
Normal file
@ -0,0 +1,33 @@
|
||||
# defer
|
||||
|
||||
::: info
|
||||
이 함수는 호환성을 위한 `es-toolkit/compat` 에서만 가져올 수 있어요. 대체할 수 있는 네이티브 JavaScript API가 있거나, 아직 충분히 최적화되지 않았기 때문이에요.
|
||||
|
||||
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
|
||||
:::
|
||||
|
||||
함수 `func`를 현재 호출 스택이 끝날 때까지 지연시켜요.
|
||||
|
||||
## 인터페이스
|
||||
|
||||
```typescript
|
||||
function defer<F extends (...args: any[]) => any>(func: F, ...args: Parameters<F>): number;
|
||||
```
|
||||
|
||||
### 파라미터
|
||||
|
||||
- `func` (`F`): 지연시킬 함수.
|
||||
- `args` (`Parameters<F>`): `func`를 호출할 인수.
|
||||
|
||||
### 반환 값
|
||||
|
||||
(`number`): 타이머 ID.
|
||||
|
||||
## 예시
|
||||
|
||||
```typescript
|
||||
defer((text) => {
|
||||
console.log(text);
|
||||
}, 'deferred');
|
||||
// => Logs 'deferred' after the current call stack has cleared.
|
||||
```
|
34
docs/ko/reference/compat/util/toFinite.md
Normal file
34
docs/ko/reference/compat/util/toFinite.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toFinite
|
||||
|
||||
::: info
|
||||
이 함수는 호환성을 위한 `es-toolkit/compat` 에서만 가져올 수 있어요. 대체할 수 있는 네이티브 JavaScript API가 있거나, 아직 충분히 최적화되지 않았기 때문이에요.
|
||||
|
||||
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
|
||||
:::
|
||||
|
||||
`value`를 유한한 숫자로 변환해요.
|
||||
|
||||
## 인터페이스
|
||||
|
||||
```typescript
|
||||
function toFinite(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 파라미터
|
||||
|
||||
- `value` (`unknown`): 변환할 값.
|
||||
|
||||
### 반환 값
|
||||
|
||||
(`number`): 유한한 숫자.
|
||||
|
||||
## 예시
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => 1.7976931348623157e+308
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => 0
|
||||
toNumber(NaN); // => 0
|
||||
```
|
34
docs/ko/reference/compat/util/toInteger.md
Normal file
34
docs/ko/reference/compat/util/toInteger.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toInteger
|
||||
|
||||
::: info
|
||||
이 함수는 호환성을 위한 `es-toolkit/compat` 에서만 가져올 수 있어요. 대체할 수 있는 네이티브 JavaScript API가 있거나, 아직 충분히 최적화되지 않았기 때문이에요.
|
||||
|
||||
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
|
||||
:::
|
||||
|
||||
`value`를 정수로 변환해요. 무한한 값인 경우, 유한한 값으로 변환돼요. 소숫점 아래 숫자는 버려요.
|
||||
|
||||
## 인터페이스
|
||||
|
||||
```typescript
|
||||
function toInteger(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 파라미터
|
||||
|
||||
- `value` (`unknown`): 변환할 값.
|
||||
|
||||
### 반환 값
|
||||
|
||||
(`number`): 변환된 정수.
|
||||
|
||||
## 예시
|
||||
|
||||
```typescript
|
||||
toInteger(3.2); // => 3
|
||||
toInteger(Number.MIN_VALUE); // => 0
|
||||
toInteger(Infinity); // => 1.7976931348623157e+308
|
||||
toInteger('3.2'); // => 3
|
||||
toInteger(Symbol.iterator); // => 0
|
||||
toInteger(NaN); // => 0
|
||||
```
|
37
docs/ko/reference/compat/util/toNumber.md
Normal file
37
docs/ko/reference/compat/util/toNumber.md
Normal file
@ -0,0 +1,37 @@
|
||||
# toNumber
|
||||
|
||||
::: info
|
||||
이 함수는 호환성을 위한 `es-toolkit/compat` 에서만 가져올 수 있어요. 대체할 수 있는 네이티브 JavaScript API가 있거나, 아직 충분히 최적화되지 않았기 때문이에요.
|
||||
|
||||
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
|
||||
:::
|
||||
|
||||
`value`를 숫자로 변환해요.
|
||||
|
||||
`Number()`와 달리, 이 함수는 Symbol에 대해 `NaN`을 반환해요.
|
||||
|
||||
## 인터페이스
|
||||
|
||||
```typescript
|
||||
function toNumber(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 파라미터
|
||||
|
||||
- `value` (`unknown`): 변환할 값이에요.
|
||||
|
||||
### 반환 값
|
||||
|
||||
(`number`): 숫자를 반환해요.
|
||||
문자열.
|
||||
|
||||
## 예시
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => Infinity
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => NaN
|
||||
toNumber(NaN); // => NaN
|
||||
```
|
28
docs/ko/reference/string/constantCase.md
Normal file
28
docs/ko/reference/string/constantCase.md
Normal file
@ -0,0 +1,28 @@
|
||||
# constantCase
|
||||
|
||||
문자열을 상수 케이스로 변환해요.
|
||||
|
||||
상수 케이스는 각 단어가 대문자로 쓰여지고 밑줄(`_`)로 구분되는 명명 규칙이에요. 예를 들어, `CONSTANT_CASE` 처럼 표기해요.
|
||||
|
||||
## 인터페이스
|
||||
|
||||
```typescript
|
||||
function constantCase(str: string): string;
|
||||
```
|
||||
|
||||
### 파라미터
|
||||
|
||||
- `str` (`string`): 상수 케이스로 변경할 문자열.
|
||||
|
||||
### 반환 값
|
||||
|
||||
(`string`): 상수 케이스로 변환된 문자열.
|
||||
|
||||
## 예시
|
||||
|
||||
```typescript
|
||||
const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'
|
||||
const convertedStr2 = constantCase('some whitespace') // returns 'SOME_WHITESPACE'
|
||||
const convertedStr3 = constantCase('hyphen-text') // returns 'HYPHEN_TEXT'
|
||||
const convertedStr4 = constantCase('HTTPRequest') // returns 'HTTP_REQUEST'
|
||||
```
|
34
docs/reference/compat/util/toFinite.md
Normal file
34
docs/reference/compat/util/toFinite.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toFinite
|
||||
|
||||
::: info
|
||||
This function is only available in `es-toolkit/compat` for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.
|
||||
|
||||
When imported from `es-toolkit/compat`, it behaves exactly like lodash and provides the same functionalities, as detailed [here](../../../compatibility.md).
|
||||
:::
|
||||
|
||||
Converts `value` to a finite number.
|
||||
|
||||
## Signature
|
||||
|
||||
```typescript
|
||||
function toFinite(value?: unknown): number;
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
- `value` (`unknown`): The value to convert.
|
||||
|
||||
### Returns
|
||||
|
||||
(`number`): The finite number.
|
||||
|
||||
## Examples
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => 1.7976931348623157e+308
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => 0
|
||||
toNumber(NaN); // => 0
|
||||
```
|
37
docs/reference/compat/util/toInteger.md
Normal file
37
docs/reference/compat/util/toInteger.md
Normal file
@ -0,0 +1,37 @@
|
||||
# toInteger
|
||||
|
||||
::: info
|
||||
This function is only available in `es-toolkit/compat` for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.
|
||||
|
||||
When imported from `es-toolkit/compat`, it behaves exactly like lodash and provides the same functionalities, as detailed [here](../../../compatibility.md).
|
||||
:::
|
||||
|
||||
Converts `value` to an integer.
|
||||
|
||||
This function first converts `value` to a finite number. If the result has any decimal places,
|
||||
they are removed by rounding down to the nearest whole number.
|
||||
|
||||
## Signature
|
||||
|
||||
```typescript
|
||||
function toInteger(value?: unknown): number;
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
- `value` (`unknown`): The value to convert.
|
||||
|
||||
### Returns
|
||||
|
||||
(`number`): The converted integer.
|
||||
|
||||
## Examples
|
||||
|
||||
```typescript
|
||||
toInteger(3.2); // => 3
|
||||
toInteger(Number.MIN_VALUE); // => 0
|
||||
toInteger(Infinity); // => 1.7976931348623157e+308
|
||||
toInteger('3.2'); // => 3
|
||||
toInteger(Symbol.iterator); // => 0
|
||||
toInteger(NaN); // => 0
|
||||
```
|
36
docs/reference/compat/util/toNumber.md
Normal file
36
docs/reference/compat/util/toNumber.md
Normal file
@ -0,0 +1,36 @@
|
||||
# toNumber
|
||||
|
||||
::: info
|
||||
This function is only available in `es-toolkit/compat` for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.
|
||||
|
||||
When imported from `es-toolkit/compat`, it behaves exactly like lodash and provides the same functionalities, as detailed [here](../../../compatibility.md).
|
||||
:::
|
||||
|
||||
Converts `value` to a number.
|
||||
|
||||
Unlike `Number()`, this function returns `NaN` for symbols.
|
||||
|
||||
## Signature
|
||||
|
||||
```typescript
|
||||
function toNumber(value?: unknown): number;
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
- `value` (`unknown`): The value to convert.
|
||||
|
||||
### Returns
|
||||
|
||||
(`number`): The converted number.
|
||||
|
||||
## Examples
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => Infinity
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => NaN
|
||||
toNumber(NaN); // => NaN
|
||||
```
|
@ -1,32 +1,28 @@
|
||||
# constantCase
|
||||
|
||||
将字符串转换为常量命名法(constant case)。
|
||||
Converts a string to constant case.
|
||||
|
||||
常量命名法是一种命名约定,其中每个单词都以大写字母书写,并用下划线(\_)分隔。
|
||||
Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
|
||||
|
||||
例如 `CONSTANT_CASE`。
|
||||
|
||||
## 签名
|
||||
## Signature
|
||||
|
||||
```typescript
|
||||
function constantCase(str: string): string;
|
||||
```
|
||||
|
||||
### 参数
|
||||
### Parameters
|
||||
|
||||
- `str` (`string`): 要转换为常量命名法的字符串。
|
||||
- `str` (`string`): The string that is to be changed to constant case.
|
||||
|
||||
### 返回值
|
||||
### Returns
|
||||
|
||||
(`string`) 转换后的常量命名法字符串。
|
||||
(`string`): The converted string to constant case.
|
||||
|
||||
## 示例
|
||||
## Examples
|
||||
|
||||
```typescript
|
||||
import { constantCase } from 'es-toolkit/string';
|
||||
|
||||
constantCase('camelCase'); // 返回 'CAMEL_CASE'
|
||||
constantCase('some whitespace'); // 返回 'SOME_WHITESPACE'
|
||||
constantCase('hyphen-text'); // 返回 'HYPHEN_TEXT'
|
||||
constantCase('HTTPRequest'); // 返回 'HTTP_REQUEST'
|
||||
```
|
||||
const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'
|
||||
const convertedStr2 = constantCase('some whitespace') // returns 'SOME_WHITESPACE'
|
||||
const convertedStr3 = constantCase('hyphen-text') // returns 'HYPHEN_TEXT'
|
||||
const convertedStr4 = constantCase('HTTPRequest') // returns 'HTTP_REQUEST'
|
||||
```
|
34
docs/zh_hans/reference/compat/util/toFinite.md
Normal file
34
docs/zh_hans/reference/compat/util/toFinite.md
Normal file
@ -0,0 +1,34 @@
|
||||
# toFinite
|
||||
|
||||
::: info
|
||||
出于兼容性原因,此函数仅在 `es-toolkit/compat` 中提供。它可能具有替代的原生 JavaScript API,或者尚未完全优化。
|
||||
|
||||
从 `es-toolkit/compat` 导入时,它的行为与 lodash 完全一致,并提供相同的功能,详情请见 [这里](../../../compatibility.md)。
|
||||
:::
|
||||
|
||||
将 `value` 转换为有限的数字。
|
||||
|
||||
## 签名
|
||||
|
||||
```typescript
|
||||
function toFinite(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 参数
|
||||
|
||||
- `value` (`unknown`): 要转换的值。
|
||||
|
||||
### 返回值
|
||||
|
||||
(`number`): 返回数字。
|
||||
|
||||
## 示例
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => 1.7976931348623157e+308
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => 0
|
||||
toNumber(NaN); // => 0
|
||||
```
|
37
docs/zh_hans/reference/compat/util/toInteger.md
Normal file
37
docs/zh_hans/reference/compat/util/toInteger.md
Normal file
@ -0,0 +1,37 @@
|
||||
# toInteger
|
||||
|
||||
::: info
|
||||
出于兼容性原因,此函数仅在 `es-toolkit/compat` 中提供。它可能具有替代的原生 JavaScript API,或者尚未完全优化。
|
||||
|
||||
从 `es-toolkit/compat` 导入时,它的行为与 lodash 完全一致,并提供相同的功能,详情请见 [这里](../../../compatibility.md)。
|
||||
:::
|
||||
|
||||
将 `value` 转换为整数。
|
||||
|
||||
此函数首先将 `value` 转换为有限数。如果结果有任何小数位,
|
||||
它们会被向下舍入到最接近的整数。
|
||||
|
||||
## 签名
|
||||
|
||||
```typescript
|
||||
function toInteger(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 参数
|
||||
|
||||
- `value` (`unknown`): 要转换的值。
|
||||
|
||||
### 返回值
|
||||
|
||||
(`number`): 返回数字。
|
||||
|
||||
## 示例
|
||||
|
||||
```typescript
|
||||
toInteger(3.2); // => 3
|
||||
toInteger(Number.MIN_VALUE); // => 0
|
||||
toInteger(Infinity); // => 1.7976931348623157e+308
|
||||
toInteger('3.2'); // => 3
|
||||
toInteger(Symbol.iterator); // => 0
|
||||
toInteger(NaN); // => 0
|
||||
```
|
36
docs/zh_hans/reference/compat/util/toNumber.md
Normal file
36
docs/zh_hans/reference/compat/util/toNumber.md
Normal file
@ -0,0 +1,36 @@
|
||||
# toNumber
|
||||
|
||||
::: info
|
||||
出于兼容性原因,此函数仅在 `es-toolkit/compat` 中提供。它可能具有替代的原生 JavaScript API,或者尚未完全优化。
|
||||
|
||||
从 `es-toolkit/compat` 导入时,它的行为与 lodash 完全一致,并提供相同的功能,详情请见 [这里](../../../compatibility.md)。
|
||||
:::
|
||||
|
||||
将 `value` 转换为数字。
|
||||
|
||||
与 `Number()` 不同,此函数对符号返回 `NaN`。
|
||||
|
||||
## 签名
|
||||
|
||||
```typescript
|
||||
function toNumber(value?: unknown): number;
|
||||
```
|
||||
|
||||
### 参数
|
||||
|
||||
- `value` (`unknown`): 要转换的值。
|
||||
|
||||
### 返回值
|
||||
|
||||
(`number`): 返回数字。
|
||||
|
||||
## 示例
|
||||
|
||||
```typescript
|
||||
toNumber(3.2); // => 3.2
|
||||
toNumber(Number.MIN_VALUE); // => 5e-324
|
||||
toNumber(Infinity); // => Infinity
|
||||
toNumber('3.2'); // => 3.2
|
||||
toNumber(Symbol.iterator); // => NaN
|
||||
toNumber(NaN); // => NaN
|
||||
```
|
@ -2,6 +2,9 @@ import { toFinite } from './toFinite';
|
||||
|
||||
/**
|
||||
* Converts `value` to an integer.
|
||||
*
|
||||
* This function first converts `value` to a finite number. If the result has any decimal places,
|
||||
* they are removed by rounding down to the nearest whole number.
|
||||
*
|
||||
* @param {unknown} value - The value to convert.
|
||||
* @returns {number} Returns the number.
|
||||
|
Loading…
Reference in New Issue
Block a user