@faasjs/func 3.2.1 → 3.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 FaasJS's function module.
 
-[![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/func/LICENSE)
+[![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/func/LICENSE)
 [![NPM Version](https://img.shields.io/npm/v/@faasjs/func.svg)](https://www.npmjs.com/package/@faasjs/func)
 
 ## Install
@@ -11,6 +11,12 @@ FaasJS's function module.
 npm install @faasjs/func
 ```
 
+## Usage
+
+## See
+
+[useFunc](functions/useFunc.md)
+
 ## Functions
 
 - [useFunc](functions/useFunc.md)

package/dist/index.d.mts

@@ -1,19 +1,5 @@
 import { Logger } from '@faasjs/logger';
 
-/**
- * FaasJS's function module.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/func/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/func.svg)](https://www.npmjs.com/package/@faasjs/func)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/func
- * ```
- * @packageDocumentation
- */
-
 type Handler<TEvent = any, TContext = any, TResult = any> = (data: InvokeData<TEvent, TContext>) => Promise<TResult>;
 type Next = () => Promise<void>;
 type ExportedHandler<TEvent = any, TContext = any, TResult = any> = (event?: TEvent, context?: TContext, callback?: (...args: any) => any) => Promise<TResult>;
@@ -127,6 +113,9 @@ declare function usePlugin<T extends Plugin>(plugin: T & {
     mount?: (data?: MountData) => Promise<T>;
 }): UseifyPlugin<T>;
 /**
+ * Create a cloud function.
+ *
+ * @example
  * ```ts
  * // pure function
  * export default useFunc(() => {
@@ -138,11 +127,13 @@ declare function usePlugin<T extends Plugin>(plugin: T & {
  * // with http
  * import { useHttp } from '@faasjs/http'
  *
- * export default useFunc(() => {
- *   const http = useHttp<{ name: string }>()
+ * export default useFunc<{
+ *   params: { name: string }
+ * }>(() => {
+ *   useHttp()
  *
- *   return () => {
- *     return `Hello ${http.params.name}`
+ *   return ({ event }) => {
+ *     return `Hello ${event.params.name}`
  *   }
  * })
  * ```

package/dist/index.d.ts

@@ -1,19 +1,5 @@
 import { Logger } from '@faasjs/logger';
 
-/**
- * FaasJS's function module.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/func/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/func.svg)](https://www.npmjs.com/package/@faasjs/func)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/func
- * ```
- * @packageDocumentation
- */
-
 type Handler<TEvent = any, TContext = any, TResult = any> = (data: InvokeData<TEvent, TContext>) => Promise<TResult>;
 type Next = () => Promise<void>;
 type ExportedHandler<TEvent = any, TContext = any, TResult = any> = (event?: TEvent, context?: TContext, callback?: (...args: any) => any) => Promise<TResult>;
@@ -127,6 +113,9 @@ declare function usePlugin<T extends Plugin>(plugin: T & {
     mount?: (data?: MountData) => Promise<T>;
 }): UseifyPlugin<T>;
 /**
+ * Create a cloud function.
+ *
+ * @example
  * ```ts
  * // pure function
  * export default useFunc(() => {
@@ -138,11 +127,13 @@ declare function usePlugin<T extends Plugin>(plugin: T & {
  * // with http
  * import { useHttp } from '@faasjs/http'
  *
- * export default useFunc(() => {
- *   const http = useHttp<{ name: string }>()
+ * export default useFunc<{
+ *   params: { name: string }
+ * }>(() => {
+ *   useHttp()
  *
- *   return () => {
- *     return `Hello ${http.params.name}`
+ *   return ({ event }) => {
+ *     return `Hello ${event.params.name}`
  *   }
  * })
  * ```

package/dist/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var logger = require('@faasjs/logger');
 var crypto = require('crypto');
+var logger = require('@faasjs/logger');
 
 // src/index.ts
 
@@ -30,6 +30,8 @@ var RunHandler = class {
     await next();
   }
 };
+
+// src/index.ts
 var Func = class {
   plugins;
   handler;
@@ -164,8 +166,9 @@ var Func = class {
         throw data.response;
       return data.response;
     };
-    handler.bind(this);
-    return { handler };
+    return {
+      handler: handler.bind(this)
+    };
   }
 };
 var plugins = [];

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { Logger } from '@faasjs/logger';
 import { randomBytes } from 'node:crypto';
+import { Logger } from '@faasjs/logger';
 
 // src/index.ts
 
@@ -28,6 +28,8 @@ var RunHandler = class {
     await next();
   }
 };
+
+// src/index.ts
 var Func = class {
   plugins;
   handler;
@@ -162,8 +164,9 @@ var Func = class {
         throw data.response;
       return data.response;
     };
-    handler.bind(this);
-    return { handler };
+    return {
+      handler: handler.bind(this)
+    };
   }
 };
 var plugins = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/func",
-  "version": "3.2.1",
+  "version": "3.4.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -34,12 +34,12 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/deep_merge": "3.2.1",
-    "@faasjs/logger": "3.2.1"
+    "@faasjs/deep_merge": "3.4.0",
+    "@faasjs/logger": "3.4.0"
   },
   "devDependencies": {
-    "@faasjs/deep_merge": "3.2.1",
-    "@faasjs/logger": "3.2.1"
+    "@faasjs/deep_merge": "3.4.0",
+    "@faasjs/logger": "3.4.0"
   },
   "engines": {
     "node": ">=22.0.0",