Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipe character in type alias is misinterpreted most of the time #5

Open
rgosse opened this issue May 19, 2021 · 0 comments
Open

Pipe character in type alias is misinterpreted most of the time #5

rgosse opened this issue May 19, 2021 · 0 comments

Comments

@rgosse
Copy link
Collaborator

rgosse commented May 19, 2021

Probably caused by:

https://github.com/Nouzbe/react-api-documenter/blob/9fc2b314c26989d09acd202426d7e4ffcb96471a/src/output/getMarkdownForType.ts#L39

Which seems to cater to things of the shape:

type A = B | C;

It produces incorrect output with the following examples:

type A = B & { foo: "bar" | "baz" };

type X = Y<Z, "alpha" | "beta">;

// etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant