GT2/Ejectable/node_modules/@expo/image-utils/README.md

14 lines
851 B
Markdown
Raw Normal View History

2021-08-16 00:14:59 +00:00
# `@expo/image-utils`
A library for image processing functionality in Expo CLI. It uses `sharp` for image processing if it's available through a global `sharp-cli` installation. Otherwise it uses `jimp`, a Node library with no native dependencies, and warns the user that they may want to install `sharp-cli` for faster image processing.
## Advanced Configuration
This package can be configured using the following environment variables.
### EXPO_IMAGE_UTILS_NO_SHARP
When truthy, this will force global `sharp-cli` resolution methods like `isAvailableAsync()` and `findSharpInstanceAsync()` to fail. Other processes can use this to fallback on Jimp for image modifications. By default this is falsy (undefined).
`findSharpInstanceAsync()` will throw an error if disabled because it shouldn't be invoked if `isAvailableAsync()` returns `false`.