docs: add docs for plugins

sst · Oct 11, 2024 · 0080c0d · 0080c0d
1 parent a62909b
commit 0080c0d
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/platform/src/components/aws/function.ts b/platform/src/components/aws/function.ts
@@ -652,6 +652,26 @@ export interface FunctionArgs {
    * cold starts.
    */
   nodejs?: Input<{
+    /**
+     * Point to a plugins.mjs file with a list of esbuild plugins.
+     *
+     * @example
+     * ```js
+     * {
+     *   nodejs: {
+     *     plugins: "./plugins.mjs"
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```js
+     * import { somePlugin } from "some-plugin"
+     * export default [
+     *   somePlugin()
+     * ]
+     * ```
+     */
     plugins?: Input<string>;
     /**
      * Configure additional esbuild loaders for other file extensions. This is useful