ReactHooksConfig | yapi-to-typescript

支持生成 React Hooks 代码的相关配置

Hierarchy

ReactHooksConfig

Index

Properties

Methods

Properties

enable

enable: boolean

是否开启该项功能。

Optional pragma

pragma: undefined | string

从何处引入 useState、useEffect 等 Hooks。

default: 'react'

Methods

Optional getAutoApiHookName

getAutoApiHookName(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string

- Defined in types.ts:265
获取自动触发 API 的 Hook 的名称。

default

useAutoApi${changeCase.pascalCase(requestFunctionName)}

Parameters
- interfaceInfo: ExtendedInterface
  
  接口信息
- changeCase: ChangeCase
  
  常用的大小写转换函数集合对象
Returns string

Hook 的名称

Optional getManualApiHookName

getManualApiHookName(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string

- Defined in types.ts:275
获取手动触发 API 的 Hook 的名称。

default

useManualApi${changeCase.pascalCase(requestFunctionName)}

Parameters
- interfaceInfo: ExtendedInterface
  
  接口信息
- changeCase: ChangeCase
  
  常用的大小写转换函数集合对象
Returns string

Hook 的名称

Generated using TypeDoc