es-toolkit/docs/usage.md

103 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2024-04-25 14:56:13 +03:00
---
description: How to use es-toolkit
2024-04-25 14:56:13 +03:00
prev:
text: Introduction to es-toolkit
link: ./intro.md
next:
text: Impact on Bundle Size
link: ./bundle-size
---
# Installation & Usage
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
You can also use es-toolkit in browsers by [importing them in CDNs](#browsers).
## 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]
pnpm add es-toolkit
2024-04-25 14:56:13 +03:00
```
```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
```
## Browsers
You can find es-toolkit on CDNs such as [jsdelivr](https://www.jsdelivr.com), [unpkg](https://unpkg.com). We define `_` to include all functions, similar to Lodash.
::: code-group
```html [jsdelivr]
<script src="https://cdn.jsdelivr.net/npm/es-toolkit@%5E1"></script>
<script>
var arr = _.chunk([1, 2, 3, 4, 5, 6], 3);
</script>
```
```html [unpkg]
<script src="https://unpkg.com/es-toolkit@%5E1"></script>
<script>
var arr = _.chunk([1, 2, 3, 4, 5, 6], 3);
</script>
```
:::
es-toolkit is also available on [esm.sh](https://esm.sh) for modern browsers.
::: code-group
```html [esm.sh]
<script type="importmap">
{
"imports": {
"es-toolkit": "https://esm.sh/es-toolkit@%5E1"
}
}
</script>
<script type="module">
import { chunk } from 'es-toolkit';
2024-10-01 08:52:25 +03:00
chunk([1, 2, 3, 4, 5, 6], 3);
</script>
```
:::