@faasjs/func 0.0.2-beta.394 → 0.0.2-beta.397

package/README.md

@@ -16,7 +16,7 @@ FaasJS's function module.
 
 - [Func](classes/Func.md)
 
-### Type aliases
+### Type Aliases
 
 - [Config](#config)
 - [DeployData](#deploydata)
@@ -36,7 +36,7 @@ FaasJS's function module.
 - [useFunc](#usefunc)
 - [usePlugin](#useplugin)
 
-## Type aliases
+## Type Aliases
 
 ### Config
 
@@ -239,10 +239,10 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `name` | `string` |
-| `type` | `string` |
 | `onDeploy?` | (`data`: [`DeployData`](#deploydata), `next`: [`Next`](#next)) => `void` \| `Promise`<`void`\> |
-| `onInvoke?` | (`data`: [`InvokeData`](#invokedata)<`any`, `any`, `any`\>, `next`: [`Next`](#next)) => `void` \| `Promise`<`void`\> |
+| `onInvoke?` | (`data`: [`InvokeData`](#invokedata), `next`: [`Next`](#next)) => `void` \| `Promise`<`void`\> |
 | `onMount?` | (`data`: [`MountData`](#mountdata), `next`: [`Next`](#next)) => `void` \| `Promise`<`void`\> |
+| `type` | `string` |
 
 ___
 
@@ -275,6 +275,26 @@ ___
 
 ▸ **useFunc**<`TEvent`, `TContext`, `TResult`\>(`handler`): [`Func`](classes/Func.md)<`TEvent`, `TContext`, `TResult`\>
 
+```ts
+// pure function
+export default useFunc(() => {
+  return () => {
+    return 'Hello World'
+  }
+})
+
+// with http
+import { useHttp } from '@faasjs/http'
+
+export default useFunc(() => {
+  const http = useHttp<{ name: string }>()
+
+  return () => {
+    return `Hello ${http.params.name}`
+  }
+})
+```
+
 #### Type parameters
 
 | Name | Type |

package/dist/index.d.ts

@@ -89,23 +89,23 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
     filename?: string;
     private cachedFunctions;
     /**
-     * 新建流程
-     * @param config {object} 配置项
-     * @param config.plugins {Plugin[]} 插件
-     * @param config.handler {Handler} 业务函数
+     * Create a cloud function
+     * @param config {object} config
+     * @param config.plugins {Plugin[]} plugins list
+     * @param config.handler {Handler} business logic
      */
     constructor(config: FuncConfig<TEvent, TContext>);
-    compose(key: LifeCycleKey): (data: any, next?: () => void) => any;
+    private compose;
     /**
-     * 发布云资源
-     * @param data {object} 代码包信息
-     * @param data.root {string} 项目根目录
-     * @param data.filename {string} 包括完整路径的流程文件名
-     * @param data.env {string} 环境
+     * Deploy the function
+     * @param data {object} data
+     * @param data.root {string} root path
+     * @param data.filename {string} filename
+     * @param data.env {string} environment
      */
     deploy(data: DeployData): any;
     /**
-     * 启动云实例
+     * First time mount the function
      */
     mount(data: {
         event: TEvent;
@@ -113,14 +113,14 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
         config?: Config;
     }): Promise<void>;
     /**
-     * 执行云函数
-     * @param data {object} 执行信息
+     * Invoke the function
+     * @param data {object} data
      */
     invoke(data: InvokeData<TEvent, TContext, TResult>): Promise<void>;
     /**
-     * 创建触发函数
+     * Export the function
      */
-    export(config?: Config): {
+    export(): {
         handler: ExportedHandler<TEvent, TContext, TResult>;
     };
 }
@@ -130,6 +130,27 @@ declare type UseifyPlugin = {
     }) => Promise<void>;
 };
 declare function usePlugin<T extends Plugin>(plugin: T & UseifyPlugin): T & UseifyPlugin;
+/**
+ * ```ts
+ * // pure function
+ * export default useFunc(() => {
+ *   return () => {
+ *     return 'Hello World'
+ *   }
+ * })
+ *
+ * // with http
+ * import { useHttp } from '@faasjs/http'
+ *
+ * export default useFunc(() => {
+ *   const http = useHttp<{ name: string }>()
+ *
+ *   return () => {
+ *     return `Hello ${http.params.name}`
+ *   }
+ * })
+ * ```
+ */
 declare function useFunc<TEvent = any, TContext = any, TResult = any>(handler: () => Handler<TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
 
 export { Config, DeployData, ExportedHandler, Func, FuncConfig, Handler, InvokeData, LifeCycleKey, MountData, Next, Plugin, ProviderConfig, UseifyPlugin, useFunc, usePlugin };

package/dist/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -62,7 +63,7 @@ var Func = class {
   constructor(config) {
     this.logger = new import_logger.Logger("Func");
     this.handler = config.handler;
-    this.plugins = config.plugins ?? [];
+    this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
     this.config = {
       providers: /* @__PURE__ */ Object.create(null),
@@ -155,9 +156,7 @@ var Func = class {
       data.response = error;
     }
   }
-  export(config) {
-    if (!this.config)
-      this.config = config || /* @__PURE__ */ Object.create(null);
+  export() {
     const handler = async (event, context, callback) => {
       const logger = new import_logger.Logger();
       if (startedAt) {
@@ -195,15 +194,6 @@ var plugins = [];
 function usePlugin(plugin) {
   if (!plugins.find((p) => p.name === plugin.name))
     plugins.push(plugin);
-  if (plugin.mount == null)
-    plugin.mount = async function({ config }) {
-      if (plugin.onMount)
-        await plugin.onMount({
-          config,
-          event: {},
-          context: {}
-        }, async () => await Promise.resolve());
-    };
   return plugin;
 }
 function useFunc(handler) {

package/dist/index.mjs

@@ -37,7 +37,7 @@ var Func = class {
   constructor(config) {
     this.logger = new Logger("Func");
     this.handler = config.handler;
-    this.plugins = config.plugins ?? [];
+    this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
     this.config = {
       providers: /* @__PURE__ */ Object.create(null),
@@ -130,9 +130,7 @@ var Func = class {
       data.response = error;
     }
   }
-  export(config) {
-    if (!this.config)
-      this.config = config || /* @__PURE__ */ Object.create(null);
+  export() {
     const handler = async (event, context, callback) => {
       const logger = new Logger();
       if (startedAt) {
@@ -170,15 +168,6 @@ var plugins = [];
 function usePlugin(plugin) {
   if (!plugins.find((p) => p.name === plugin.name))
     plugins.push(plugin);
-  if (plugin.mount == null)
-    plugin.mount = async function({ config }) {
-      if (plugin.onMount)
-        await plugin.onMount({
-          config,
-          event: {},
-          context: {}
-        }, async () => await Promise.resolve());
-    };
   return plugin;
 }
 function useFunc(handler) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/func",
-  "version": "0.0.2-beta.394",
+  "version": "0.0.2-beta.397",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,8 +22,8 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/deep_merge": "^0.0.2-beta.394",
-    "@faasjs/logger": "^0.0.2-beta.394"
+    "@faasjs/deep_merge": "^0.0.2-beta.397",
+    "@faasjs/logger": "^0.0.2-beta.397"
   },
   "devDependencies": {
     "tsup": "*",