@faasjs/react 0.0.2-beta.362 → 0.0.2-beta.363

package/README.md

@@ -1,12 +1,14 @@
 # @faasjs/react
 
-React 插件
-
 [![License: MIT](https://img.shields.io/npm/l/@faasjs/react.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/react/LICENSE)
 [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/react/stable.svg)](https://www.npmjs.com/package/@faasjs/react)
 [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/react/beta.svg)](https://www.npmjs.com/package/@faasjs/react)
 
-https://faasjs.com/guide/excel/react.html
+React plugin for FaasJS.
+
+## Install
+
+    npm install @faasjs/react
 
 ## Modules
 
@@ -18,19 +20,19 @@ https://faasjs.com/guide/excel/react.html
 
 ### Type aliases
 
-- [FaasDataInjection](modules.md#faasdatainjection)
-- [FaasDataWrapperProps](modules.md#faasdatawrapperprops)
-- [FaasReactClientInstance](modules.md#faasreactclientinstance)
-- [Options](modules.md#options)
-- [ResponseHeaders](modules.md#responseheaders)
+- [FaasDataInjection](#faasdatainjection)
+- [FaasDataWrapperProps](#faasdatawrapperprops)
+- [FaasReactClientInstance](#faasreactclientinstance)
+- [Options](#options)
+- [ResponseHeaders](#responseheaders)
 
 ### Functions
 
-- [FaasDataWrapper](modules.md#faasdatawrapper)
-- [FaasReactClient](modules.md#faasreactclient)
-- [faas](modules.md#faas)
-- [getClient](modules.md#getclient)
-- [useFaas](modules.md#usefaas)
+- [FaasDataWrapper](#faasdatawrapper)
+- [FaasReactClient](#faasreactclient)
+- [faas](#faas)
+- [getClient](#getclient)
+- [useFaas](#usefaas)
 
 ## Type aliases
 
@@ -38,6 +40,8 @@ https://faasjs.com/guide/excel/react.html
 
 Ƭ **FaasDataInjection**<`Data`\>: `Object`
 
+Injects FaasData props.
+
 #### Type parameters
 
 | Name | Type |
@@ -81,8 +85,8 @@ ___
 | `fallback?` | `JSX.Element` \| ``false`` | - |
 | `params?` | `FaasParams`<`PathOrData`\> | - |
 | `setData?` | `React.Dispatch`<`React.SetStateAction`<`FaasData`<`PathOrData`\>\>\> | use custom setData, should work with data |
-| `onDataChange?` | (`args`: [`FaasDataInjection`](modules.md#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `void` | - |
-| `render?` | (`args`: [`FaasDataInjection`](modules.md#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
+| `onDataChange?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `void` | - |
+| `render?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
 
 ___
 
@@ -94,15 +98,15 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `FaasDataWrapper` | <PathOrData\>(`props`: [`FaasDataWrapperProps`](modules.md#faasdatawrapperprops)<`PathOrData`\>) => `Element` |
+| `FaasDataWrapper` | <PathOrData\>(`props`: [`FaasDataWrapperProps`](#faasdatawrapperprops)<`PathOrData`\>) => `Element` |
 | `faas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `params`: `FaasParams`<`PathOrData`\>) => `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\> |
-| `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: `FaasParams`<`PathOrData`\>) => [`FaasDataInjection`](modules.md#faasdatainjection)<`FaasData`<`PathOrData`\>\> |
+| `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: `FaasParams`<`PathOrData`\>) => [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\> |
 
 ___
 
 ### Options
 
-Ƭ **Options**: `RequestInit` & { `headers?`: { [key: string]: `string`;  } ; `beforeRequest?`: (`__namedParameters`: { `action`: `string` ; `options`: [`Options`](modules.md#options) ; `params`: `Record`<`string`, `any`\>  }) => `void` \| `Promise`<`void`\>  }
+Ƭ **Options**: `RequestInit` & { `headers?`: { [key: string]: `string`;  } ; `beforeRequest?`: (`__namedParameters`: { `action`: `string` ; `options`: [`Options`](#options) ; `params`: `Record`<`string`, `any`\>  }) => `void` \| `Promise`<`void`\>  }
 
 ___
 
@@ -122,16 +126,6 @@ ___
 
 A data wrapper for react components
 
-**`example`**
-<FaasDataWrapper<{
-  id: string
-  title: string
-}>
-  action='post/get'
-  params={ { id: 1 } }
-  render={ ({ data }) => <h1>{ data.title }</h1> }
-/>
-
 #### Type parameters
 
 | Name | Type |
@@ -142,37 +136,49 @@ A data wrapper for react components
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`FaasDataWrapperProps`](modules.md#faasdatawrapperprops)<`PathOrData`\> |
+| `props` | [`FaasDataWrapperProps`](#faasdatawrapperprops)<`PathOrData`\> |
 
 #### Returns
 
 `JSX.Element`
 
+```ts
+<FaasDataWrapper<{
+  id: string
+  title: string
+}>
+  action='post/get'
+  params={ { id: 1 } }
+  render={ ({ data }) => <h1>{ data.title }</h1> }
+/>
+```
+
 ___
 
 ### FaasReactClient
 
-▸ **FaasReactClient**(`__namedParameters`): [`FaasReactClientInstance`](modules.md#faasreactclientinstance)
+▸ **FaasReactClient**(`__namedParameters`): [`FaasReactClientInstance`](#faasreactclientinstance)
 
 Before use faas, you should initialize a FaasReactClient.
 
-**`example`**
-const client = FaasReactClient({
-  domain: 'localhost:8080/api'
-})
-
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `__namedParameters` | `Object` |
 | `__namedParameters.domain` | `string` |
-| `__namedParameters.options?` | [`Options`](modules.md#options) |
+| `__namedParameters.options?` | [`Options`](#options) |
 | `__namedParameters.onError?` | (`action`: `string`, `params`: `Record`<`string`, `any`\>) => (`res`: [`ResponseError`](classes/ResponseError.md)) => `Promise`<`void`\> |
 
 #### Returns
 
-[`FaasReactClientInstance`](modules.md#faasreactclientinstance)
+[`FaasReactClientInstance`](#faasreactclientinstance)
+
+```ts
+const client = FaasReactClient({
+  domain: 'localhost:8080/api'
+})
+```
 
 ___
 
@@ -182,11 +188,6 @@ ___
 
 Request faas server
 
-**`example`**
-faas<{ title: string }>('post/get', { id: 1 }).then(res => {
-  console.log(res.data.title)
-})
-
 #### Type parameters
 
 | Name | Type |
@@ -204,19 +205,20 @@ faas<{ title: string }>('post/get', { id: 1 }).then(res => {
 
 `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\>
 
+```ts
+faas<{ title: string }>('post/get', { id: 1 }).then(res => {
+  console.log(res.data.title)
+})
+```
+
 ___
 
 ### getClient
 
-▸ **getClient**(`domain?`): [`FaasReactClientInstance`](modules.md#faasreactclientinstance)
+▸ **getClient**(`domain?`): [`FaasReactClientInstance`](#faasreactclientinstance)
 
 Get FaasReactClient instance
 
-**`example`**
-getClient()
-// or
-getClient('another-domain')
-
 #### Parameters
 
 | Name | Type | Description |
@@ -225,23 +227,22 @@ getClient('another-domain')
 
 #### Returns
 
-[`FaasReactClientInstance`](modules.md#faasreactclientinstance)
+[`FaasReactClientInstance`](#faasreactclientinstance)
+
+```ts
+getClient()
+// or
+getClient('another-domain')
+```
 
 ___
 
 ### useFaas
 
-▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](modules.md#faasdatainjection)<`FaasData`<`PathOrData`\>\>
+▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
 
 Request faas server with React hook
 
-**`example`**
-function Post ({ id }) {
-  const { data } = useFaas<{ title: string }>('post/get', { id })
-
-  return <h1>{data.title}</h1>
-}
-
 #### Type parameters
 
 | Name | Type |
@@ -257,4 +258,11 @@ function Post ({ id }) {
 
 #### Returns
 
-[`FaasDataInjection`](modules.md#faasdatainjection)<`FaasData`<`PathOrData`\>\>
+[`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
+
+```ts
+function Post ({ id }) {
+  const { data } = useFaas<{ title: string }>('post/get', { id })
+  return <h1>{data.title}</h1>
+}
+```

package/dist/index.d.ts

@@ -2,6 +2,9 @@ import { Response, Options, ResponseError } from '@faasjs/browser';
 export { FaasBrowserClient, Options, Response, ResponseError, ResponseHeaders } from '@faasjs/browser';
 import { FaasAction, FaasData, FaasParams } from '@faasjs/types';
 
+/**
+ * Injects FaasData props.
+ */
 declare type FaasDataInjection<Data = any> = {
     action: string | any;
     params: Record<string, any>;
@@ -37,10 +40,12 @@ declare type FaasReactClientInstance = {
  * @param props.domain {string} The domain of your faas server
  * @param props.options {Options} The options of client
  * @returns {FaasReactClientInstance}
- * @example
+ *
+ * ```ts
  * const client = FaasReactClient({
  *   domain: 'localhost:8080/api'
  * })
+ * ```
  */
 declare function FaasReactClient({ domain, options, onError }: {
     domain: string;
@@ -51,10 +56,12 @@ declare function FaasReactClient({ domain, options, onError }: {
  * Get FaasReactClient instance
  * @param domain {string} empty string for default domain
  * @returns {FaasReactClientInstance}
- * @example
+ *
+ * ```ts
  * getClient()
  * // or
  * getClient('another-domain')
+ * ```
  */
 declare function getClient(domain?: string): FaasReactClientInstance;
 /**
@@ -63,10 +70,12 @@ declare function getClient(domain?: string): FaasReactClientInstance;
  * @param action {string} action name
  * @param params {object} action params
  * @returns {Promise<Response<any>>}
- * @example
+ *
+ * ```ts
  * faas<{ title: string }>('post/get', { id: 1 }).then(res => {
  *   console.log(res.data.title)
  * })
+ * ```
  */
 declare function faas<PathOrData extends FaasAction>(action: string | PathOrData, params: FaasParams<PathOrData>): Promise<Response<FaasData<PathOrData>>>;
 /**
@@ -74,18 +83,20 @@ declare function faas<PathOrData extends FaasAction>(action: string | PathOrData
  * @param action {string} action name
  * @param defaultParams {object} initial action params
  * @returns {FaasDataInjection<any>}
- * @example
+ *
+ * ```ts
  * function Post ({ id }) {
  *   const { data } = useFaas<{ title: string }>('post/get', { id })
- *
  *   return <h1>{data.title}</h1>
  * }
+ * ```
  */
 declare function useFaas<PathOrData extends FaasAction>(action: string | PathOrData, defaultParams: FaasParams<PathOrData>): FaasDataInjection<FaasData<PathOrData>>;
 /**
  * A data wrapper for react components
  * @returns {JSX.Element}
- * @example
+ *
+ * ```ts
  * <FaasDataWrapper<{
  *   id: string
  *   title: string
@@ -94,6 +105,7 @@ declare function useFaas<PathOrData extends FaasAction>(action: string | PathOrD
  *   params={ { id: 1 } }
  *   render={ ({ data }) => <h1>{ data.title }</h1> }
  * />
+ * ```
  */
 declare function FaasDataWrapper<PathOrData extends FaasAction>(props: FaasDataWrapperProps<PathOrData>): JSX.Element;
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@faasjs/react",
-  "version": "0.0.2-beta.362",
+  "version": "0.0.2-beta.363",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
-  "homepage": "https://faasjs.com/doc/react.html",
+  "homepage": "https://faasjs.com/doc/react",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/faasjs/faasjs.git",
@@ -23,8 +23,8 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/browser": "^0.0.2-beta.362",
-    "@faasjs/types": "^0.0.2-beta.362",
+    "@faasjs/browser": "^0.0.2-beta.363",
+    "@faasjs/types": "^0.0.2-beta.363",
     "react": "*"
   },
   "devDependencies": {