The props-type from taehwanno

A quick fix for the "Limits" section

In the https://github.com/taehwanno/props-type#limits section of the README.md file you mention the issue with oneOf. I don't think it's inherently a problem of InferProps from the @types/prop-types but simply how TypeScript handles array literals.

A simple fix for this issue is to use as const assertion introduced in TS 3.4, like so:

const propTypes = {
  type: PropTypes.oneOf(['button', 'submit', 'reset'] as const),
};

However, this does not resolve the issue of defaultProps still widening the type. Which again can be solved with simple as const assertion 😉

const defaultProps = {
  type: 'button',
} as const;

There is however an issue when using React.FC type for functional components which I haven't found a solution for yet, except for maybe casting it in the assignment expression:

const Button : React.FC<ButtonProps> = ({ type }) => { /* ... */ }

Button.propTypes = propTypes; // type error
(Button as React.FC<PropTypes.InferProps<typeof propTypes>>).propTypes = propTypes; // not ideal - very explicit but way too verbose
Button.propTypes = propTypes as any; // less verbose, the `Button.propTypes` original type is preserved
Button.defaultProps = defaultProps;

Error:

Type '{ type: Requireable<"button" | "submit" | "reset">; }' is not assignable to type 'WeakValidationMap<WithDefaultProps<InferProps<{ type: Requireable<"button" | "submit" | "reset">; }>, { readonly type: "button"; }>>'.
  Types of property 'type' are incompatible.
    Type 'Requireable<"button" | "submit" | "reset">' is not assignable to type 'Validator<"button" | "submit" | "reset">'.
      Types of property '[nominalTypeHack]' are incompatible.
        Type '{ type: "button" | "submit" | "reset" | null | undefined; } | undefined' is not assignable to type '{ type: "button" | "submit" | "reset"; } | undefined'.
          Type '{ type: "button" | "submit" | "reset" | null | undefined; }' is not assignable to type '{ type: "button" | "submit" | "reset"; }'.
            Types of property 'type' are incompatible.
              Type '"button" | "submit" | "reset" | null | undefined' is not assignable to type '"button" | "submit" | "reset"'.
                Type 'undefined' is not assignable to type '"button" | "submit" | "reset"'.ts(2322)

PS. great job on the package! found it after translating your Medium article 🙂

taehwanno / props-type Goto Github PK

props-type's People

Contributors

Stargazers

Watchers

props-type's Issues

A quick fix for the "Limits" section

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent