From 33bdce125444036955b58fff9d1e2bf6c4a5f941 Mon Sep 17 00:00:00 2001 From: raon0211 Date: Tue, 10 Sep 2024 22:46:57 +0900 Subject: [PATCH] docs(parseInt): Add docs for parseInt --- docs/ja/reference/compat/string/parseInt.md | 39 +++++++++++++++++++++ docs/ko/reference/compat/string/parseInt.md | 38 ++++++++++++++++++++ 2 files changed, 77 insertions(+) create mode 100644 docs/ja/reference/compat/string/parseInt.md create mode 100644 docs/ko/reference/compat/string/parseInt.md diff --git a/docs/ja/reference/compat/string/parseInt.md b/docs/ja/reference/compat/string/parseInt.md new file mode 100644 index 00000000..2c320c21 --- /dev/null +++ b/docs/ja/reference/compat/string/parseInt.md @@ -0,0 +1,39 @@ +# parseInt + +::: info +この関数は互換性のために `es-toolkit/compat` からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。 + +`es-toolkit/compat` からこの関数をインポートすると、[lodash と完全に同じように動作](../../../compatibility.md)します。 +::: + +文字列を整数に変換します。基数を `radix` パラメータで定義できます。 + +基数 `radix` が未定義または0の場合、与えられた文字列の形式に応じて異なる基数が使用されます。文字列が `0x20` のように16進数の場合、基数は16が使用されます。それ以外の場合、基数は10が使用されます。 + +## インターフェース + +```typescript +function parseInt(string: string, radix: number, guard?: unknown): number; +``` + +### パラメータ + +- `string` (`string`): 整数に変換する文字列。 +- `radix` (`number`): 文字列を整数に変換する際に使用する基数。デフォルトは`0`です。 +- `guard` (`unknown`): `Array#map`のようなメソッドでイテレートとして使用可能にします。 + +### 戻り値 + +(`number`): 変換された整数を返しますます。 + +## 例 + +```typescript +parseInt('08'); // => 8 +parseInt('0x20'); // => 32 + +parseInt('08', 10); // => 8 +parseInt('0x20', 16); // => 32 + +['6', '08', '10'].map(parseInt); // => [6, 8, 10] +``` diff --git a/docs/ko/reference/compat/string/parseInt.md b/docs/ko/reference/compat/string/parseInt.md new file mode 100644 index 00000000..d0c8c5b5 --- /dev/null +++ b/docs/ko/reference/compat/string/parseInt.md @@ -0,0 +1,38 @@ +# parseInt + +::: info +이 함수는 호환성을 위한 `es-toolkit/compat` 에서만 가져올 수 있어요. 대체할 수 있는 네이티브 JavaScript API가 있거나, 아직 충분히 최적화되지 않았기 때문이에요. + +`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요. +::: + +문자열을 정수로 바꿔요. 기수를 `radix` 파라미터로 정의할 수 있어요. + +기수 `radix`가 정의되지 않았거나 0인 경우에는, 주어진 문자열의 형식에 따라서 다른 기수가 사용돼요. 문자열이 `0x20`처럼 16진수인 경우에는, 기수를 16으로 사용해요. 그렇지 않으면 기수를 10으로 사용해요. + +## 인터페이스 + +```typescript +function parseInt(string: string, radix?: number): number; +``` + +### 파라미터 + +- `string` (`string`): 정수로 변환할 문자열. +- `radix` (`number`): 문자열을 정수로 변환할 때 사용할 기수. 기본값은 `0`이에요. + +### 반환 값 + +(`number`): 변환된 정수. + +## 예시 + +```typescript +parseInt('08'); // => 8 +parseInt('0x20'); // => 32 + +parseInt('08', 10); // => 8 +parseInt('0x20', 16); // => 32 + +['6', '08', '10'].map(parseInt); // => [6, 8, 10] +```