npm - @faasjs/func - Versions diffs - 1.4.1 → 1.5.0 - Mend

@faasjs/func 1.4.1 → 1.5.0

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 (4) hide show

package/README.md CHANGED Viewed

@@ -1,338 +1,36 @@
 # @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)
 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
 ```
-## Modules
-### Classes
+## 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` |
-| `onDeploy?` | (`data`: [`DeployData`](#deploydata), `next`: [`Next`](#next)) => `Promise`\<`void`\> |
-| `onInvoke?` | (`data`: [`InvokeData`](#invokedata), `next`: [`Next`](#next)) => `Promise`\<`void`\> |
-| `onMount?` | (`data`: [`MountData`](#mountdata), `next`: [`Next`](#next)) => `Promise`\<`void`\> |
-| `type` | `string` |
-___
-### ProviderConfig
-Ƭ **ProviderConfig**: `Object`
-#### Type declaration
-| Name | Type |
-| :------ | :------ |
-| `config` | \{ `[key: string]`: `any`;  } |
-| `type` | `string` |
-___
-### UseifyPlugin
-Ƭ **UseifyPlugin**\<`T`\>: `T` & \{ `mount?`: (`data?`: \{ `config?`: [`Config`](#config)  }) => `Promise`\<`T`\>  }
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
+- [Config](type-aliases/Config.md)
+- [DeployData](type-aliases/DeployData.md)
+- [ExportedHandler](type-aliases/ExportedHandler.md)
+- [FuncConfig](type-aliases/FuncConfig.md)
+- [Handler](type-aliases/Handler.md)
+- [InvokeData](type-aliases/InvokeData.md)
+- [LifeCycleKey](type-aliases/LifeCycleKey.md)
+- [MountData](type-aliases/MountData.md)
+- [Next](type-aliases/Next.md)
+- [Plugin](type-aliases/Plugin.md)
+- [ProviderConfig](type-aliases/ProviderConfig.md)
+- [UseifyPlugin](type-aliases/UseifyPlugin.md)
 ## Functions
-### useFunc
-▸ **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 |
-| :------ | :------ |
-| `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`): [`UseifyPlugin`](#useifyplugin)\<`T`\>
-#### Type parameters
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`Plugin`](#plugin) |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `plugin` | [`UseifyPlugin`](#useifyplugin)\<`T`\> |
-#### Returns
-[`UseifyPlugin`](#useifyplugin)\<`T`\>
+- [useFunc](functions/useFunc.md)
+- [usePlugin](functions/usePlugin.md)

package/dist/index.d.mts CHANGED Viewed

@@ -1,5 +1,19 @@
 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>;

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,19 @@
 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>;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/func",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,8 +21,8 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/deep_merge": "1.4.1",
-    "@faasjs/logger": "1.4.1"
+    "@faasjs/deep_merge": "1.5.0",
+    "@faasjs/logger": "1.5.0"
   },
   "engines": {
     "npm": ">=9.0.0",