# aloo-tools

**Repository Path**: yuyalong/aloo-tools

## Basic Information

- **Project Name**: aloo-tools
- **Description**: 通用工具函数
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-18
- **Last Updated**: 2025-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Aloo Tools

一个实用的TypeScript工具库，为日常开发提供有用的函数。

[![npm version](https://img.shields.io/npm/v/aloo-tools.svg)](https://www.npmjs.com/package/aloo-tools)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## 特点

- 🔒 **类型安全**：完全使用TypeScript编写，带有完整的类型声明
- 🪶 **轻量级**：支持Tree-shaking，模块化设计，保持您的包体积小
- 🛠️ **全面**：为字符串、数字、数组、对象和日期提供实用工具

## 安装

```bash
npm install aloo-tools
```

## 快速开始

```ts
import { capitalize, formatDate } from 'aloo-tools';

const capitalized = capitalize('hello world'); // "Hello world"
const today = formatDate(new Date()); // "2023-07-15" (格式: YYYY-MM-DD)
```

## 可用工具

### 字符串工具

```ts
import { capitalize, toCamelCase, truncate } from 'aloo-tools';

capitalize('hello world'); // "Hello world"
toCamelCase('hello-world'); // "helloWorld"
truncate('这是一个很长的字符串', 10); // "这是一个很长..."
```

### 数字工具

```ts
import { clamp, formatNumber, roundTo } from 'aloo-tools';

clamp(15, 0, 10); // 10
formatNumber(1234567); // "1,234,567"
roundTo(3.14159, 2); // 3.14
```

### 数组工具

```ts
import { chunk, unique, shuffle } from 'aloo-tools';

chunk([1, 2, 3, 4, 5], 2); // [[1, 2], [3, 4], [5]]
unique([1, 2, 2, 3, 3, 3]); // [1, 2, 3]
shuffle([1, 2, 3, 4, 5]); // [3, 1, 5, 2, 4] (随机顺序)
```

### 对象工具

```ts
import { deepClone, pick, omit } from 'aloo-tools';

deepClone({ a: 1, b: { c: 2 } }); // { a: 1, b: { c: 2 } } (新引用)
pick({ a: 1, b: 2, c: 3 }, ['a', 'c']); // { a: 1, c: 3 }
omit({ a: 1, b: 2, c: 3 }, ['b']); // { a: 1, c: 3 }
```

### 日期工具

```ts
import { formatDate, addDays, isToday } from 'aloo-tools';

formatDate(new Date(), 'YYYY-MM-DD'); // "2023-07-15"
addDays(new Date(), 5); // 5天后的日期
isToday(new Date()); // true
```

## 文档

完整文档请访问 [https://yourusername.github.io/aloo-tools](https://yourusername.github.io/aloo-tools)。

## 许可证

MIT