Millify

https://www.npmjs.com/package/millify
Admin
Converts long numbers into pretty, human-readable strings (e.g., 2000 becomes '2K', 1250000 becomes...
Tokens:7,951
Snippets:65
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Millify

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Install the millify package using npm. This is the first step to using the library in your project.

```bash
npm install millify
```

--------------------------------

### Millify with Custom Options

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Configure millify's output by providing an options object. This example demonstrates setting precision and using lowercase abbreviations.

```javascript
millify(1024000, {
  precision: 3,
  lowercase: true
});
// 1.024m
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=dependencies

Demonstrates how to import and use the millify function in your JavaScript projects. It shows basic usage and examples with various options.

```APIDOC
## `millify(value: number, options: MillifyOptions)`

### Description
Converts a given number into a human-readable string with appropriate units and formatting.

### Parameters
#### `value` (number) - Required
 The number to convert.

#### `options` (MillifyOptions) - Optional
 An object containing configuration options for the conversion.

### Options
- `precision` (number): Number of decimal places to use. Default is `1`.
- `locales` (string | Array<string>): Formats the number in different languages. Default is browser language.
- `lowercase` (boolean): Use lowercase abbreviations. Default is `false`.
- `space` (boolean): Add a space between the number and abbreviation. Default is `false`.
- `units` (Array<string>): Unit abbreviations to use. Default is `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example
```javascript
import millify from "millify";

// For CommonJS: const { millify } = require("millify");

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
}); // Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
}); // Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
}); // Returns "1.44 MB"
```

### Response
#### Success Response
- Returns a `string` representing the formatted number.
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=code

Demonstrates how to use the millify function in JavaScript code. It shows basic usage and examples with various options like precision, locales, lowercase, space, and units.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

This function converts a number into a human-readable string with abbreviations.

**Parameters**

- **value** (number) - The number to convert.
- **options** (MillifyOptions) - An optional object to customize the output.

### Options

- **precision** (number) - Default: `1`. Number of decimal places to use.
- **locales** (string | Array<string>) - Default: browser language. Formats the number in different languages.
- **lowercase** (boolean) - Default: `false`. Use lowercase abbreviations.
- **space** (boolean) - Default: `false`. Add a space between number and abbreviation.
- **units** (Array<string>) - Default: `['', 'K', 'M', 'B', 'T', 'P', 'E']`. Unit abbreviations.

### Request Example

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // Returns '2.5K'

millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns '1.024m'

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns '3,95K'

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns '1.44 MB'
```
```

--------------------------------

### Millify with Locales

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Format numbers according to specific locales for internationalization. This example uses the German locale.

```javascript
millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// 3,95K
```

--------------------------------

### Millify Programmatic Usage with Locales

Source: https://www.npmjs.com/package/millify?activeTab=readme

Format numbers according to specific locales using the `locales` option. This example formats the number for German locale with precision set to 2.

```javascript
millify(39500, {
  precision: 2,  
  locales: "de-DE"
});
// 3,95K
```

--------------------------------

### Command Line Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=dependents

Shows how to use millify directly from the command line.

```APIDOC
## Command Line Usage

Execute millify directly from your terminal.

### Command Example

```bash
$ millify 12345
```

### Response Example

```
12.3K
```

For more options, see `millify --help`.
```

--------------------------------

### Command Line Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=code

Shows how to use millify directly from the command line.

```APIDOC
## Command Line Usage

To use millify from the command line, you can execute it with a number as an argument.

### Request Example

```bash
$ millify 12345
```

### Response Example

```
12.3K
```

See `millify --help` for available options.
```

--------------------------------

### Command Line Usage

Source: https://www.npmjs.com/package/millify?activeTab=versions

Shows how to use the millify tool directly from the command line.

```APIDOC
## Command Line Usage

```bash
$ millify 12345
12.3K
```

See `millify --help` for options.
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=dependents

Demonstrates how to use the millify function programmatically with various options.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

Converts a number into a human-readable string.

#### Parameters

*   **value** (number) - The number to convert.
*   **options** (MillifyOptions) - Optional configuration object.

    *   **precision** (number) - Optional. Number of decimal places to use. Defaults to `1`.
    *   **locales** (string | Array<string>) - Optional. Formats the number in different languages. Defaults to browser language.
    *   **lowercase** (boolean) - Optional. Use lowercase abbreviations. Defaults to `false`.
    *   **space** (boolean) - Optional. Add a space between number and abbreviation. Defaults to `false`.
    *   **units** (Array<string>) - Optional. Unit abbreviations. Defaults to `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns "1.44 MB"
```

### Response Example

```json
{
  "example": "2.5K"
}
```
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify

Demonstrates how to use the millify function programmatically with various options.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

Converts a number into a human-readable string.

#### Parameters

*   **value** (`number`) - The number to convert.
*   **options** (`MillifyOptions`, optional) - An object to configure the formatting.

### Options

*   **`precision`** (`number`, optional, default: `1`) - Number of decimal places to use.
*   **`locales`** (`string | Array<string>`, optional, default: browser language) - Formats the number in different languages.
*   **`lowercase`** (`boolean`, optional, default: `false`) - Use lowercase abbreviations.
*   **`space`** (`boolean`, optional, default: `false`) - Add a space between number and abbreviation.
*   **`units`** (`Array<string>`, optional, default: `['', 'K', 'M', 'B', 'T', 'P', 'E']`) - Unit abbreviations.

### Examples

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // 2.5K

millify(1024000, {
  precision: 3,
  lowercase: true
});
// 1.024m

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// 3,95K

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// 1.44 MB
```
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=readme

Demonstrates how to use the millify function programmatically with various options.

```APIDOC
## Programmatic Usage

### Function Signature
`millify(value: number, options: MillifyOptions)`

### Description
Converts a given number into a human-readable string format. The `options` object allows for customization.

### Parameters
#### `value` (number) - Required
 The number to convert.

#### `options` (MillifyOptions) - Optional
 An object to configure the conversion process.

##### `precision` (number) - Optional, Default: `1`
 Number of decimal places to use.

##### `locales` (string | Array<string>) - Optional, Default: browser language
 Formats the number in different languages.

##### `lowercase` (boolean) - Optional, Default: `false`
 Use lowercase abbreviations.

##### `space` (boolean) - Optional, Default: `false`
 Add a space between the number and the abbreviation.

##### `units` (Array<string>) - Optional, Default: `['', 'K', 'M', 'B', 'T', 'P', 'E']`
 Unit abbreviations to use.

### Examples
```javascript
import millify from "millify";

// Basic usage
millify(2500); // Returns "2.5K"

// With custom options
millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns "1.44 MB"
```
```

--------------------------------

### Millify Command Line Usage

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Use millify directly from the command line to format numbers. See `millify --help` for available options.

```bash
$ millify 12345
12.3K
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=dependencies

Demonstrates how to use the millify function in your JavaScript code. It shows basic usage and how to customize output with options like precision, locales, lowercase, space, and units.

```APIDOC
## `millify(value: number, options: MillifyOptions)`

### Description
Converts a given number into a human-readable string with appropriate units and formatting.

### Parameters
#### `value` (number) - Required
The number to convert.

#### `options` (MillifyOptions) - Optional
An object to configure the conversion process.

### Options
- `precision` (number): Number of decimal places to use. Defaults to `1`.
- `locales` (string | Array<string>): Formats the number in different languages. Defaults to browser language.
- `lowercase` (boolean): Use lowercase abbreviations. Defaults to `false`.
- `space` (boolean): Add a space between the number and abbreviation. Defaults to `false`.
- `units` (Array<string>): Unit abbreviations to use. Defaults to `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example
```javascript
import millify from "millify";

// Basic usage
millify(2500); // Returns "2.5K"

// With options
millify(1024000, {
  precision: 3,
  lowercase: true
}); // Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
}); // Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
}); // Returns "1.44 MB"
```

### Response
Returns a string representing the formatted number.
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Demonstrates how to use the millify function programmatically in JavaScript, including basic usage and options.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

This function converts a number into a human-readable string.

#### Parameters

- **value** (number) - The number to convert.
- **options** (MillifyOptions) - Optional configuration object.

##### `MillifyOptions`

- **precision** (number) - Optional. Number of decimal places to use. Defaults to `1`.
- **locales** (string | Array<string>) - Optional. Formats the number in different languages. Defaults to browser language.
- **lowercase** (boolean) - Optional. Use lowercase abbreviations. Defaults to `false`.
- **space** (boolean) - Optional. Add a space between number and abbreviation. Defaults to `false`.
- **units** (Array<string>) - Optional. Unit abbreviations. Defaults to `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns "1.44 MB"
```

### Response

- **string** - The formatted human-readable string.
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=versions

Demonstrates how to use the millify function programmatically in JavaScript, including basic usage and options.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

Converts a number into a human-readable string.

**Parameters**

*   `value` (number): The number to convert.
*   `options` (MillifyOptions): An optional object to customize the output.

### Request Example

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns "1.44 MB"
```

### Options

| Name      | Type                     | Default | Description                                  |
|-----------|--------------------------|---------|----------------------------------------------|
| `precision` | `number`                 | `1`     | Number of decimal places to use.             |
| `locales`   | `string | Array<string>` | browser language | Formats the number in different languages.   |
| `lowercase` | `boolean`                | `false` | Use lowercase abbreviations.                 |
| `space`     | `boolean`                | `false` | Add a space between number and abbreviation. |
| `units`     | `Array<string>`          | `['', 'K', 'M', 'B', 'T', 'P', 'E']` | Unit abbreviations.                          |
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0

Demonstrates how to use the millify function programmatically within your JavaScript code. It shows basic usage and how to customize output with options.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

This function converts a given number into a human-readable string.

#### Parameters

- **value** (number) - The number to convert.
- **options** (MillifyOptions) - Optional configuration object to customize the output.

### Options

- **`precision`** (number): Number of decimal places to use. Defaults to `1`.
- **`locales`** (string | Array<string>): Formats the number in different languages. Defaults to browser language.
- **`lowercase`** (boolean): Use lowercase abbreviations. Defaults to `false`.
- **`space`** (boolean): Add a space between number and abbreviation. Defaults to `false`.
- **`units`** (Array<string>): Unit abbreviations to use. Defaults to `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example

```javascript
import millify from "millify";

// Basic usage
millify(2500); // Returns "2.5K"

// With options
millify(1024000, {
  precision: 3,
  lowercase: true
}); // Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
}); // Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
}); // Returns "1.44 MB"
```

### Response Example

- **Success Response**:
  - Returns a string representing the formatted number.

```json
{
  "formatted_number": "string"
}
```
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=code

Demonstrates how to use the millify function programmatically in JavaScript, including various options for customization.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

This function converts a number into a human-readable string.

**Parameters**

- `value` (number): The number to convert.
- `options` (MillifyOptions): An optional object to customize the output.

### Options

- `precision` (number): Number of decimal places to use. Default is `1`.
- `locales` (string | Array<string>): Formats the number in different languages. Default is browser language.
- `lowercase` (boolean): Use lowercase abbreviations. Default is `false`.
- `space` (boolean): Add a space between number and abbreviation. Default is `false`.
- `units` (Array<string>): Unit abbreviations to use. Default is `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
});
// Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// Returns "1.44 MB"
```

### Response Example

- `string`: The formatted, human-readable string representation of the number.
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=readme

Demonstrates how to use the millify function programmatically within your JavaScript code. It shows basic usage and how to apply options for customization.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

This function converts a given number into a human-readable string.

**Parameters**

- `value` (number): The number to convert.
- `options` (MillifyOptions): An optional object to customize the output.

### Options

- `precision` (number): Number of decimal places to use. Default is `1`.
- `locales` (string | Array<string>): Formats the number in different languages. Default is browser language.
- `lowercase` (boolean): Use lowercase abbreviations. Default is `false`.
- `space` (boolean): Add a space between number and abbreviation. Default is `false`.
- `units` (Array<string>): Unit abbreviations to use. Default is `['', 'K', 'M', 'B', 'T', 'P', 'E']`.

### Request Example

```javascript
import millify from "millify";

// Basic usage
millify(2500); // Returns "2.5K"

// With options
millify(1024000, {
  precision: 3,
  lowercase: true
}); // Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
}); // Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
}); // Returns "1.44 MB"
```

### Response Example

```json
{
  "example": "2.5K"
}
```

```json
{
  "example": "1.024m"
}
```

```json
{
  "example": "3,95K"
}
```

```json
{
  "example": "1.44 MB"
}
```
```

--------------------------------

### Programmatic Usage

Source: https://www.npmjs.com/package/millify/v/6.1.0?activeTab=versions

Demonstrates how to use the millify function in your JavaScript code. It takes a number and an optional options object to customize the output.

```APIDOC
## Programmatic Usage

### `millify(value: number, options: MillifyOptions)`

Import the function and use it to convert numbers.

```javascript
import millify from "millify";

// For CommonJS:
// const { millify } = require("millify");

millify(2500); // Returns "2.5K"

millify(1024000, {
  precision: 3,
  lowercase: true
}); // Returns "1.024m"

millify(39500, {
  precision: 2,
  locales: "de-DE"
}); // Returns "3,95K"

millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
}); // Returns "1.44 MB"
```

### Options

| Name      | Type                     | Default         | Description                                  |
|-----------|--------------------------|-----------------|----------------------------------------------|
| `precision` | `number`                 | `1`             | Number of decimal places to use.             |
| `locales`   | `string | Array<string>` | browser language | Formats the number in different languages.   |
| `lowercase` | `boolean`                | `false`         | Use lowercase abbreviations.                 |
| `space`     | `boolean`                | `false`         | Add a space between number and abbreviation. |
| `units`     | `Array<string>`          | `['', 'K', 'M', 'B', 'T', 'P', 'E']` | Unit abbreviations.                          |
```

--------------------------------

### Millify Programmatic Usage with Options

Source: https://www.npmjs.com/package/millify?activeTab=code

Customize millify's output using options like precision, lowercase, and locales.

```javascript
millify(1024000, {
  precision: 3,
  lowercase: true
});
// 1.024m
```

```javascript
millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// 3,95K
```

```javascript
millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// 1.44 MB
```

--------------------------------

### Millify Programmatic Usage

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Import and use the millify function in your JavaScript code. For CommonJS environments, use `require`.

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // 2.5K
```

--------------------------------

### Programmatic usage of millify

Source: https://www.npmjs.com/package/millify/v/6.1.0

Import and use the millify function in your JavaScript code. For CommonJS, use `const { millify } = require("millify");`.

```javascript
import millify from "millify";

// For CommonJS: `const { millify } = require("millify");`

millify(2500); // 2.5K
```

```javascript
millify(1024000, {
  precision: 3,
  lowercase: true
});
// 1.024m
```

```javascript
millify(39500, {
  precision: 2,
  locales: "de-DE"
});
// 3,95K
```

```javascript
millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// 1.44 MB
```

--------------------------------

### Millify with Custom Units and Space

Source: https://www.npmjs.com/package/millify?activeTab=dependents

Customize the units used for abbreviations and control whether a space is added between the number and the unit.

```javascript
millify(1440000, {
  units: ["B", "KB", "MB", "GB", "TB"],
  space: true,
});
// 1.44 MB
```
Tokens:
Raw