es-toolkit/docs/installation.md

58 lines
1.1 KiB
Markdown
Raw Normal View History

2024-04-25 14:56:13 +03:00
---
description: How to install es-toolkit
prev:
text: Introduction to es-toolkit
link: ./intro.md
next:
text: Impact on Bundle Size
link: ./bundle-size
---
# Installation
2024-04-25 14:56:13 +03:00
2024-06-30 08:53:42 +03:00
es-toolkit is available via [npm](https://npmjs.com/package/es-toolkit) for Node.js and Bun, and through [JSR](https://jsr.io/@es-toolkit/es-toolkit) for Deno.
2024-04-25 14:56:13 +03:00
## Node.js
2024-04-25 14:56:13 +03:00
es-toolkit supports Node.js 18 or later. Install es-toolkit with the following command:
::: code-group
```sh [npm]
2024-04-25 14:56:13 +03:00
npm install es-toolkit
```
```sh [pnpm]
2024-04-25 14:56:13 +03:00
pnpm install es-toolkit
```
```sh [yarn]
yarn add es-toolkit
```
:::
## Deno
2024-04-25 14:56:13 +03:00
2024-06-30 08:53:42 +03:00
es-toolkit is also available via [JSR](https://jsr.io/@es-toolkit/es-toolkit) for Deno. To install es-toolkit, use the following command:
2024-06-30 07:43:58 +03:00
```sh
deno add @es-toolkit/es-toolkit
```
Note that the package name includes an additional scope, distinct from npm, as per JSR restrictions.
2024-04-25 14:56:13 +03:00
```typescript
2024-06-30 07:43:58 +03:00
import { sum } from '@es-toolkit/es-toolkit';
sum([1, 2, 3]);
2024-04-25 14:56:13 +03:00
```
## Bun
2024-04-25 14:56:13 +03:00
es-toolkit is also available on Bun. You can install it via the following command:
```sh
bun add es-toolkit
```