Skip to content

Commit 8f8318f

Browse files
committed
docs(i18n): add multilingual README variants
1 parent ec80e22 commit 8f8318f

4 files changed

Lines changed: 357 additions & 207 deletions

File tree

README.ja.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# kr-corekit
2+
3+
言語: [English](./README.md) | [한국어](./README.ko.md) | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md)
4+
5+
lodash/es-toolkit 風の API を目指した JavaScript/TypeScript ユーティリティライブラリです。
6+
7+
## 特徴
8+
9+
- 文字列・配列・オブジェクト・非同期・Promise・日付・数値など 130+ 関数
10+
- Tree-shaking しやすいモジュール export
11+
- TypeScript `.d.ts` 型定義を提供
12+
- ESM/CJS バンドルを提供
13+
14+
## インストール
15+
16+
```bash
17+
npm install kr-corekit
18+
# or
19+
pnpm add kr-corekit
20+
# or
21+
yarn add kr-corekit
22+
```
23+
24+
## クイックスタート
25+
26+
```ts
27+
import {
28+
stringUtil,
29+
arrayUtil,
30+
objectUtil,
31+
asyncUtil,
32+
promiseUtil,
33+
dateUtil,
34+
mathUtil,
35+
langUtil,
36+
} from "kr-corekit";
37+
38+
const id = stringUtil.camelCase("user profile id");
39+
const rows = arrayUtil.chunk([1, 2, 3, 4, 5], 2);
40+
const city = objectUtil.get({ user: { profile: { city: "Seoul" } } }, "user.profile.city");
41+
42+
const mapped = await asyncUtil.mapAsync([1, 2, 3], async (v) => v * 2);
43+
const safe = await promiseUtil.withTimeout(fetch("/api/health"), 1000);
44+
45+
const tomorrow = dateUtil.addDays(new Date(), 1);
46+
const average = mathUtil.mean([10, 20, 30]);
47+
const enabled = langUtil.toBoolean("yes");
48+
```
49+
50+
## モジュール
51+
52+
- `stringUtil`: ケース変換、HTML escape/unescape、truncate、slugify
53+
- `arrayUtil`: chunk、flatten、uniq/uniqBy、groupBy、sortBy、集合演算、サンプリング
54+
- `collectionUtil`: 配列/オブジェクト向け map/filter/reduce/find/every/some/includes
55+
- `objectUtil`: get/set/has/merge/defaults/pick/omit/deepClone/deepFreeze
56+
- `numberUtil`: clamp、inRange、random、ceil/floor/round、sum/subtract/multiply
57+
- `mathUtil`: mean/median/min/max/sumBy/minBy/maxBy
58+
- `dateUtil`: 日時加減算、start/end of day、formatDate、日付比較
59+
- `langUtil`: toBoolean/toNumber/toString/defaultTo/castArray/isEqual
60+
- `asyncUtil`: pLimit、mapAsync、filterAsync、eachAsync、series、parallel
61+
- `promiseUtil`: defer、withTimeout、retryWithDelay、settle、toResult
62+
- 既存モジュール: `commonUtil`, `functionUtil`, `validationUtil`, `formatUtil`, `typeUtil`, `cookieUtil`, `deviceUtil`, `searchQueryUtil`
63+
64+
## Tree-Shaking インポート
65+
66+
```ts
67+
import { camelCase } from "kr-corekit/stringUtil";
68+
import { chunk } from "kr-corekit/arrayUtil";
69+
import { get } from "kr-corekit/objectUtil";
70+
import { mapAsync } from "kr-corekit/asyncUtil";
71+
import { withTimeout } from "kr-corekit/promiseUtil";
72+
```
73+
74+
## ベンチマーク
75+
76+
```bash
77+
npm run benchmark
78+
```
79+
80+
ビルド後にローカルのマイクロベンチマーク [`benchmark/index.mjs`](./benchmark/index.mjs) を実行します。
81+
82+
最新ローカルサンプル(2026-02-25):
83+
84+
```text
85+
array.chunk ~1,065,050 ops/s
86+
object.get ~2,681,055 ops/s
87+
string.camelCase ~1,902,407 ops/s
88+
async.mapAsync ~1,514,005 ops/s
89+
```
90+
91+
## 補足
92+
93+
- API 全体は `package/*/index.ts``dist/types/*/index.d.ts` で確認できます。
94+
- 関数ドキュメントを拡張する場合は多言語 README を同期してください。
95+
96+
## ライセンス
97+
98+
MIT

README.ko.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# kr-corekit
2+
3+
언어: [English](./README.md) | [한국어](./README.ko.md) | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md)
4+
5+
lodash/es-toolkit 스타일 API를 지향하는 JavaScript/TypeScript 유틸리티 모음입니다.
6+
7+
## 핵심 특징
8+
9+
- 문자열/배열/객체/비동기/Promise/날짜/수학/언어 유틸 포함 130개+ 함수
10+
- 트리 셰이킹에 유리한 모듈 export 구조
11+
- TypeScript `.d.ts` 타입 제공
12+
- ESM/CJS 번들 제공
13+
14+
## 설치
15+
16+
```bash
17+
npm install kr-corekit
18+
# or
19+
pnpm add kr-corekit
20+
# or
21+
yarn add kr-corekit
22+
```
23+
24+
## 빠른 사용 예시
25+
26+
```ts
27+
import {
28+
stringUtil,
29+
arrayUtil,
30+
objectUtil,
31+
asyncUtil,
32+
promiseUtil,
33+
dateUtil,
34+
mathUtil,
35+
langUtil,
36+
} from "kr-corekit";
37+
38+
const id = stringUtil.camelCase("user profile id");
39+
const rows = arrayUtil.chunk([1, 2, 3, 4, 5], 2);
40+
const city = objectUtil.get({ user: { profile: { city: "Seoul" } } }, "user.profile.city");
41+
42+
const mapped = await asyncUtil.mapAsync([1, 2, 3], async (v) => v * 2);
43+
const safe = await promiseUtil.withTimeout(fetch("/api/health"), 1000);
44+
45+
const tomorrow = dateUtil.addDays(new Date(), 1);
46+
const average = mathUtil.mean([10, 20, 30]);
47+
const enabled = langUtil.toBoolean("yes");
48+
```
49+
50+
## 모듈 구성
51+
52+
- `stringUtil`: 케이스 변환, HTML escape/unescape, truncate, slugify
53+
- `arrayUtil`: chunk, flatten, uniq/uniqBy, groupBy, sortBy, 집합 연산, 샘플링
54+
- `collectionUtil`: 배열/객체 대상 map/filter/reduce/find/every/some/includes
55+
- `objectUtil`: get/set/has/merge/defaults/pick/omit/deepClone/deepFreeze
56+
- `numberUtil`: clamp, inRange, random, ceil/floor/round, sum/subtract/multiply
57+
- `mathUtil`: mean/median/min/max/sumBy/minBy/maxBy
58+
- `dateUtil`: 일/시간 가감, 하루 시작/끝, formatDate, 날짜 비교
59+
- `langUtil`: toBoolean/toNumber/toString/defaultTo/castArray/isEqual
60+
- `asyncUtil`: pLimit, mapAsync, filterAsync, eachAsync, series, parallel
61+
- `promiseUtil`: defer, withTimeout, retryWithDelay, settle, toResult
62+
- 기존 모듈: `commonUtil`, `functionUtil`, `validationUtil`, `formatUtil`, `typeUtil`, `cookieUtil`, `deviceUtil`, `searchQueryUtil`
63+
64+
## 트리 셰이킹 import
65+
66+
```ts
67+
import { camelCase } from "kr-corekit/stringUtil";
68+
import { chunk } from "kr-corekit/arrayUtil";
69+
import { get } from "kr-corekit/objectUtil";
70+
import { mapAsync } from "kr-corekit/asyncUtil";
71+
import { withTimeout } from "kr-corekit/promiseUtil";
72+
```
73+
74+
## 벤치마크
75+
76+
```bash
77+
npm run benchmark
78+
```
79+
80+
빌드 후 [`benchmark/index.mjs`](./benchmark/index.mjs) 기반 로컬 마이크로 벤치마크를 실행합니다.
81+
82+
최신 로컬 샘플 (2026-02-25):
83+
84+
```text
85+
array.chunk ~1,065,050 ops/s
86+
object.get ~2,681,055 ops/s
87+
string.camelCase ~1,902,407 ops/s
88+
async.mapAsync ~1,514,005 ops/s
89+
```
90+
91+
## 참고
92+
93+
- 전체 API는 `package/*/index.ts``dist/types/*/index.d.ts`에서 확인할 수 있습니다.
94+
- 함수별 문서를 더 확장할 경우 다국어 README 파일을 함께 동기화하세요.
95+
96+
## 라이선스
97+
98+
MIT

0 commit comments

Comments
 (0)