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

iAPI: Refactor types and add a "Core Concepts - Using TypeScript" guide #64577

Merged
merged 33 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
567e58f
Initial version
luisherranz Aug 16, 2024
b0a1f50
Add a section with instructions to install the package
luisherranz Aug 19, 2024
ed247cb
Add basic create-block template for typescript
luisherranz Aug 20, 2024
205409f
Fix all the types
luisherranz Aug 21, 2024
35b511d
Reorganize the sections on how to type the store
luisherranz Aug 22, 2024
051dfcf
Add a test for when the store is divided into multiple parts
luisherranz Aug 22, 2024
28b487e
Update the example of when the store is divided into multiple parts
luisherranz Aug 22, 2024
0c3ca4d
Try a `typed` function to type promises
luisherranz Aug 26, 2024
52e576c
Refactor derived state and async actions
luisherranz Aug 26, 2024
2f83604
Add an example casting the entire state
luisherranz Aug 27, 2024
0574763
Add entry to the changelog
luisherranz Aug 27, 2024
b1de4ed
Add last section and conclusion
luisherranz Aug 29, 2024
403e2f4
Remove the template
luisherranz Aug 29, 2024
333581d
Add basic JSDoc for the typed function
luisherranz Aug 29, 2024
0646735
Export `typed`
luisherranz Aug 29, 2024
2fd8e05
Delete template from manifest
luisherranz Aug 29, 2024
343621b
Add the skeleton for TypeScript variant of the template
gziolo Aug 30, 2024
9d4e2ae
Merge branch 'trunk' into iapi-docs-typescript-guide
luisherranz Aug 30, 2024
f4e0d6c
Add types and global state to the template
luisherranz Aug 30, 2024
7eaec3c
Add the scaffolding section again
luisherranz Aug 30, 2024
958e086
Add a note and `@since` annotation to the `typed` function to ensure …
luisherranz Aug 30, 2024
e2517f4
Added typescript guide to the README of Core Concepts, toc.json and …
juanmaguitar Sep 9, 2024
2b0b956
Merge branch 'trunk' into iapi-docs-typescript-guide
sirreal Sep 9, 2024
1576566
Improve iapi type "tests"
sirreal Sep 9, 2024
563d4b0
Add tsconfig for type tests
sirreal Sep 9, 2024
ac5590f
REVERTME: Introduce intentional type error
sirreal Sep 9, 2024
85136a4
Revert "REVERTME: Introduce intentional type error"
sirreal Sep 9, 2024
de897f3
fixup! Merge branch 'trunk' into iapi-docs-typescript-guide
sirreal Sep 9, 2024
d7422d0
Merge branch 'trunk' into iapi-docs-typescript-guide
sirreal Sep 18, 2024
bc80b10
Remove typed function
sirreal Sep 18, 2024
415a55b
Remove references to `typed` function from docs
sirreal Sep 18, 2024
72b8441
Update and fix changelog
sirreal Sep 18, 2024
00f751c
Merge branch 'trunk' into iapi-docs-typescript-guide
juanmaguitar Sep 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,12 @@
"markdown_source": "../docs/reference-guides/interactivity-api/core-concepts/server-side-rendering.md",
"parent": "core-concepts"
},
{
"title": "Using TypeScript",
"slug": "using-typescript",
"markdown_source": "../docs/reference-guides/interactivity-api/core-concepts/using-typescript.md",
"parent": "core-concepts"
},
{
"title": "Quick start guide",
"slug": "iapi-quick-start-guide",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ This section provides some guides on important concepts and mental models relate
2. **[Understanding global state, local context and derived state](/docs/reference-guides/interactivity-api/core-concepts/undestanding-global-state-local-context-and-derived-state.md):** The guide explains how to effectively use global state, local context, and derived state within the Interactivity API emphasizing the importance of choosing the appropriate state management technique based on the scope and requirements of your data.

3. **[Server-side rendering: Processing directives on the server](/docs/reference-guides/interactivity-api/core-concepts/server-side-rendering.md):** The Interactivity API allows WordPress to use server-side rendering to create interactive and state-aware HTML, smoothly connected with client-side features while maintaining performance and SEO benefits.

4. **[Using TypeScript](/docs/reference-guides/interactivity-api/core-concepts/using-typescript.md):** This guide will walk you through the process of using TypeScript with Interactivity API stores, covering everything from basic type definitions to advanced techniques for handling complex store structures.
Loading
Loading