npm - @faasjs/func - Versions diffs - 0.0.2-beta.361 → 0.0.2-beta.365 - Mend

@faasjs/func 0.0.2-beta.361 → 0.0.2-beta.365

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +310 -3
package/package.json +3 -3

package/README.md CHANGED Viewed

@@ -1,9 +1,316 @@
 # @faasjs/func
-云函数模块。
 [![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/func/LICENSE)
 [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/func/stable.svg)](https://www.npmjs.com/package/@faasjs/func)
 [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/func/beta.svg)](https://www.npmjs.com/package/@faasjs/func)
-https://faasjs.com/doc/
+FaasJS's function module.
+## Install
+    npm install @faasjs/func
+## Modules
+### Classes
+- [Func](classes/Func.md)
+### Type aliases
+- [Config](#config)
+- [DeployData](#deploydata)
+- [ExportedHandler](#exportedhandler)
+- [FuncConfig](#funcconfig)
+- [Handler](#handler)
+- [InvokeData](#invokedata)
+- [LifeCycleKey](#lifecyclekey)
+- [MountData](#mountdata)
+- [Next](#next)
+- [Plugin](#plugin)
+- [ProviderConfig](#providerconfig)
+- [UseifyPlugin](#useifyplugin)
+### Functions
+- [useFunc](#usefunc)
+- [usePlugin](#useplugin)
+## Type aliases
+### Config
+Ƭ **Config**: `Object`
+#### Index signature
+▪ [key: `string`]: `any`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `plugins?` | { [key: string]: { [key: string]: `any`; `config?`: { [key: string]: `any`;  } ; `provider?`: `string` \| [`ProviderConfig`](#providerconfig) ; `type`: `string`  };  } |
+| `providers?` | { [key: string]: [`ProviderConfig`](#providerconfig);  } |
+___
+### DeployData
+Ƭ **DeployData**: `Object`
+#### Index signature
+▪ [key: `string`]: `any`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `config?` | [`Config`](#config) |
+| `dependencies` | { [name: string]: `string`;  } |
+| `env?` | `string` |
+| `filename` | `string` |
+| `logger?` | `Logger` |
+| `name?` | `string` |
+| `plugins?` | { [name: string]: { [key: string]: `any`; `config`: { [key: string]: `any`;  } ; `name?`: `string` ; `plugin`: [`Plugin`](#plugin) ; `provider?`: `string` ; `type`: `string`  };  } |
+| `root` | `string` |
+| `version?` | `string` |
+___
+### ExportedHandler
+Ƭ **ExportedHandler**<`TEvent`, `TContext`, `TResult`\>: (`event`: `TEvent`, `context?`: `TContext`, `callback?`: (...`args`: `any`) => `any`) => `Promise`<`TResult`\>
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `TEvent` | `any` |
+| `TContext` | `any` |
+| `TResult` | `any` |
+#### Type declaration
+▸ (`event`, `context?`, `callback?`): `Promise`<`TResult`\>
+##### Parameters
+| Name | Type |
+| :------ | :------ |
+| `event` | `TEvent` |
+| `context?` | `TContext` |
+| `callback?` | (...`args`: `any`) => `any` |
+##### Returns
+`Promise`<`TResult`\>
+___
+### FuncConfig
+Ƭ **FuncConfig**<`TEvent`, `TContext`, `TResult`\>: `Object`
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `TEvent` | `any` |
+| `TContext` | `any` |
+| `TResult` | `any` |
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `handler?` | [`Handler`](#handler)<`TEvent`, `TContext`, `TResult`\> |
+| `plugins?` | [`Plugin`](#plugin)[] |
+___
+### Handler
+Ƭ **Handler**<`TEvent`, `TContext`, `TResult`\>: (`data`: [`InvokeData`](#invokedata)<`TEvent`, `TContext`\>) => `Promise`<`TResult`\>
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `TEvent` | `any` |
+| `TContext` | `any` |
+| `TResult` | `any` |
+#### Type declaration
+▸ (`data`): `Promise`<`TResult`\>
+##### Parameters
+| Name | Type |
+| :------ | :------ |
+| `data` | [`InvokeData`](#invokedata)<`TEvent`, `TContext`\> |
+##### Returns
+`Promise`<`TResult`\>
+___
+### InvokeData
+Ƭ **InvokeData**<`TEvent`, `TContext`, `TResult`\>: `Object`
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `TEvent` | `any` |
+| `TContext` | `any` |
+| `TResult` | `any` |
+#### Index signature
+▪ [key: `string`]: `any`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `callback` | `any` |
+| `config` | [`Config`](#config) |
+| `context` | `TContext` |
+| `event` | `TEvent` |
+| `handler?` | [`Handler`](#handler)<`TEvent`, `TContext`, `TResult`\> |
+| `logger` | `Logger` |
+| `response` | `any` |
+___
+### LifeCycleKey
+Ƭ **LifeCycleKey**: ``"onDeploy"`` \| ``"onMount"`` \| ``"onInvoke"``
+___
+### MountData
+Ƭ **MountData**: `Object`
+#### Index signature
+▪ [key: `string`]: `any`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `config` | [`Config`](#config) |
+| `context` | `any` |
+| `event` | `any` |
+___
+### Next
+Ƭ **Next**: () => `Promise`<`void`\>
+#### Type declaration
+▸ (): `Promise`<`void`\>
+##### Returns
+`Promise`<`void`\>
+___
+### Plugin
+Ƭ **Plugin**: `Object`
+#### Index signature
+▪ [key: `string`]: `any`
+#### Type declaration
+| 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`\> |
+| `onMount?` | (`data`: [`MountData`](#mountdata), `next`: [`Next`](#next)) => `void` \| `Promise`<`void`\> |
+___
+### ProviderConfig
+Ƭ **ProviderConfig**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `config` | { [key: string]: `any`;  } |
+| `type` | `string` |
+___
+### UseifyPlugin
+Ƭ **UseifyPlugin**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `mount?` | (`data`: { `config`: [`Config`](#config)  }) => `Promise`<`void`\> |
+## Functions
+### useFunc
+▸ **useFunc**<`TEvent`, `TContext`, `TResult`\>(`handler`): [`Func`](classes/Func.md)<`TEvent`, `TContext`, `TResult`\>
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `TEvent` | `any` |
+| `TContext` | `any` |
+| `TResult` | `any` |
+#### Parameters
+| Name | Type |
+| :------ | :------ |
+| `handler` | () => [`Handler`](#handler)<`TEvent`, `TContext`, `TResult`\> |
+#### Returns
+[`Func`](classes/Func.md)<`TEvent`, `TContext`, `TResult`\>
+___
+### usePlugin
+▸ **usePlugin**<`T`\>(`plugin`): `T` & [`UseifyPlugin`](#useifyplugin)
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`Plugin`](#plugin) |
+#### Parameters
+| Name | Type |
+| :------ | :------ |
+| `plugin` | `T` & [`UseifyPlugin`](#useifyplugin) |
+#### Returns
+`T` & [`UseifyPlugin`](#useifyplugin)

package/package.json CHANGED Viewed

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