---
title: formatNumber
nav:
  title: Tools
  path: /tools
group:
  title: Utils
toc: content
---

## formatNumber

Demo:

```tsx
/**
 * title: 基础用法
 * description: 数字千分位格式化函数
 */

import React from 'react';
import { formatNumber } from 'aim-tools';

const result1 = formatNumber(11276789304.14);
const result2 = formatNumber('17725673.88');

export default () => (
  <pre>
    <code>
      formatNumber(11276789304.14); // {result1}
      <br />
      <br />
      formatNumber("17725673.88"); // {result2}
    </code>
  </pre>
);
```

### API

```typescript
formatNumber(number: number | string);
```

### Params

| 参数   | 说明             | 类型             | 默认值 | 必填 |
| :----- | :--------------- | :--------------- | :----- | :--- |
| number | 需要格式化的数字 | number or string | -      | 是   |

### Returns

| 返回值 | 说明             |
| :----- | :--------------- |
| -      | 千分位处理后的值 |