docs: Add section explaining aync transforms to docs

JonasKruckenberg · May 7, 2021 · fcb47d8 · fcb47d8
1 parent da3e726
commit fcb47d8
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 9 deletions.
diff --git a/docs/guide/extending.md b/docs/guide/extending.md
@@ -12,10 +12,6 @@ The signature is as follows:
 type TransformFactory<A = {}> = (metadata: Partial<ImageConfig & A>, ctx: TransformFactoryContext) => ImageTransformation | undefined
 ```
 
-## Directive Context
-
-
-
 ## Example
 
 Say you're using the following import statement very often
@@ -83,6 +79,20 @@ We must also always return the transformed image.
 
 > NOTE: The image object provided to the transform function is a sharp instance, so you have access to all it's methods as well.
 
+### Asyn ImageTransform functions
+
+![vite-imagetools v2.4.0 and newer](https://img.shields.io/badge/imagetools--core-^2.4.0-brightgreen) ![vite-imagetools v3.5.3 and newer](https://img.shields.io/badge/vite--imagetools-^3.5.3-brightgreen) ![rollup-plugin-imagetools v2.1.3](https://img.shields.io/badge/rollup--plugin--imagetools-^2.1.3-brightgreen)
+
+Sometimes a transformation needs to perform some asynchronous action. To accommodate this, ImageTransform functions can return a promise that resolved with the sharp instance once the transformation is done.
+
+```ts
+function customDirective(): ImageTransform {
+    return async (image) => {
+        return longAsyncTask(image)
+    }
+}
+```
+
 ## Custom Output Formats
 
 _TODO_
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "imagetools-core",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",

diff --git a/packages/rollup/package.json b/packages/rollup/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-imagetools",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@rollup/pluginutils": "^4.1.0",
-    "imagetools-core": "^2.3.3",
+    "imagetools-core": "^2.4.0",
     "magic-string": "^0.25.7"
   },
   "devDependencies": {

diff --git a/packages/vite/package.json b/packages/vite/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vite-imagetools",
   "description": "Load and transform images using a toolbox of import directives!",
-  "version": "3.5.2",
+  "version": "3.5.3",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@rollup/pluginutils": "^4.1.0",
-    "imagetools-core": "^2.3.3",
+    "imagetools-core": "^2.4.0",
     "magic-string": "^0.25.7"
   },
   "devDependencies": {