为react组件库添加typescript类型提示

Z时代
2024-01-10
分类：技术分享

以我自己的组件react-better-countdown为例，

首先在package.json里面添加types: types/index.d.ts，，

然后文件目录上添加对应文件夹和文件，

最后是index.d.ts文件的编写，具体看代码:

import * as React from 'react';
interface CountdownProps {
count?: number;
dayText?: string | React.ReactElement;
hourText?: string | React.ReactElement;
minuteText?: string | React.ReactElement;
secondText?: string | React.ReactElement;
callback?: Function;
className?: string;
style?: React.CSSProperties;
rest?: any
}
interface CountdownState {
count?: number;
}
declare module 'react-better-countdown' {
export default class Countdown extends React.Component<CountdownProps, CountdownState> {
state: CountdownState;
timer: null | number;
tick: () => void;
componentDidMount(): void;
componentDidUpdate(prevProps: CountdownProps): void;
componentWillUnmount(): void;
render: () => React.ReactElement;
}}