Currently, I am in the process of developing a React application. It is common to want the props of a child component to be directly connected to the state of a parent component.
To achieve this, I have detailed the following instructions in the interface of the parent class component's state.
// Parent.tsx
interface ParentState {
/**
* This stores any errors that occur during rendering.
*/
errors: string[];
}
export function Parent extends React.Component<{}, ParentState> {
// ...
render () {
return <Child errors={errors} />
}
}
In a separate file, within the child component, I aim to have the ChildProps interface share the same information.
// Child.tsx
interface ChildProps {
/**
* How can the definition of `ParentState.errors` be utilized here?
*/
errors: string[]
}
export function Child (props: ChildProps) {
return <ul>{errors.map(error) => <li key={index}>error</li>}</ul>
}
I attempted using the JSDoc
@borrow module:Parent.ParentState.errors@module Parent for the Parent component. But unfortunately, I am struggling to connect these two documentations. Despite my efforts, the documentation for the child prop does not appear in VSCode intellisense.
So, my query is: How can I borrow documentation from an external interface property?