Skip to content

Add generated types declaration for minimal typescript support - #447

Open
Shelob9 wants to merge 3 commits into
WP-API:masterfrom
Shelob9:feature/149
Open

Shelob9 wants to merge 3 commits into
WP-API:masterfrom
Shelob9:feature/149

Conversation

@Shelob9

@Shelob9 Shelob9 commented Oct 30, 2019

Copy link
Copy Markdown

Typescript support would be great. Automatically generating types, without having to fully re-write this in typescript is an easier first step.

To build this file -- in another projec that had wpapi installed, I added a directory called "types" than I ran npx dts-gen -m wpapi -d wpapi. I copied types/index.d.ts into wpai.

So, if this manual way is good enough for now, then automating that process would be the next step to make this useful.

Would fix #149

@unrevised6419

Copy link
Copy Markdown

@Shelob9 check this PR Shelob9#1 it will merge in your feature/149 branch

@Shelob9
Shelob9 marked this pull request as ready for review November 6, 2019 14:40
@Fredobumma

Copy link
Copy Markdown

For anyone still looking for typed access to the WordPress REST API from JavaScript: I've published wordpress-rest-sdk, a TypeScript client whose types are generated from WordPress's own route schemas. They cover all 257 core routes in WordPress 7.1, and responses narrow to the _fields you ask for. It's a separate library rather than types for wpapi, so it doesn't close this issue, but it may help people who land here. Feedback is welcome.

This branch has not been deployed

No deployments
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

Successfully merging this pull request may close these issues.

Consider adding a TypeScript definitions file

3 participants