Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: add section on (preventing) bundling with esbuild

Browse Source
This commit is contained in:
Lovell Fuller 2022-03-12 13:17:36 +00:00
parent ac18bbbc7c
commit 72fd8abe2c
2 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/install.md
View File

@ -213,9 +213,11 @@ SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install --arch=x64 --platform=linux sharp
To get the best performance select the largest memory available. To get the best performance select the largest memory available.
A 1536 MB function provides ~12x more CPU time than a 128 MB function. A 1536 MB function provides ~12x more CPU time than a 128 MB function.
## Webpack ## Bundlers
Ensure sharp is added to the ### webpack
Ensure sharp is excluded from bundling via the
[externals](https://webpack.js.org/configuration/externals/) [externals](https://webpack.js.org/configuration/externals/)
configuration. configuration.
@ -225,6 +227,25 @@ externals: {
} }
``` ```
### esbuild
Ensure sharp is excluded from bundling via the
[external](https://esbuild.github.io/api/#external)
configuration.
```js
buildSync({
entryPoints: ['app.js'],
bundle: true,
platform: 'node',
external: ['sharp'],
})
```
```sh
esbuild app.js --bundle --platform=node --external:sharp
```
## Worker threads ## Worker threads
The main thread must call `require('sharp')` The main thread must call `require('sharp')`

2
docs/search-index.json
View File

File diff suppressed because one or more lines are too long