是否可以将带有 jsdoc 子项或渲染道具用作函数的文档?

Dan*_*elo 3 jsdoc reactjs

我正在尝试使用 react 渲染模式创建一个包装器组件,但我也想记录通过渲染/子项传递的参数,例如,为了获得有用的智能感知。

我试图定义我自己的组件,React.ExoticComponent<React.ConsumerProps<MYTYPE>>但是这样做意味着像 a 一样声明组件<Context.Consumer>,隐藏输入道具。

const Wrapper = ({children}) => {

    const exampleFunction = () => {} 

    return (
        <div>
            {children({exampleFunction})}
        </div>
    )
}

const ImplementationComponent = () => {

    const exampleFunction = () => {} 

    return (
        <Wrapper>
            {({exampleFunction}) => (
                // <Components...>
            )}
        </Wrapper>
    )
}

Run Code Online (Sandbox Code Playgroud)

我想要在实现中进行类型检查,以帮助谁应该使用包装器组件。

Jos*_*man 6

/** @param {{ children: JSX.Element}} [Props] */

const Wrapper = ({children}) => {...}
Run Code Online (Sandbox Code Playgroud)