Clean up types and expose more types to users #1816
Conversation
|
|
✔️ Deploy Preview for astro-www ready! 🔨 Explore the source changes: a564ba2 🔍 Inspect the deploy log: https://app.netlify.com/sites/astro-www/deploys/61933858e5772c00084e29ac 😎 Browse the preview: https://deploy-preview-1816--astro-www.netlify.app |
|
❌ Deploy Preview for astro-docs-2 failed. 🔨 Explore the source changes: a564ba2 🔍 Inspect the deploy log: https://app.netlify.com/sites/astro-docs-2/deploys/619338586383870007ac38ee |
cbca4f2
to
1a1f1bf
Compare
| * The Astro User Config Format: | ||
| * This is the type interface for your astro.config.mjs default export. | ||
| * Astro.* available in all components | ||
| * Docs: https://docs.astro.build/reference/api-reference/#astro-global |
There was a problem hiding this comment.
Adding a URL makes finding the API docs easier
| * Page Prop | ||
| * Docs: https://docs.astro.build/guides/pagination/#using-the-page-prop | ||
| */ | ||
| export interface Page<T = any> { |
There was a problem hiding this comment.
One example of renaming PaginatedCollectionProps to simply Page for users to find more easily.
1a1f1bf
to
66a1b42
Compare
|
If you rebase with |
bee61ae
to
d6aedfd
Compare
Also add JSDoc to external types
d6aedfd
to
a564ba2
Compare
Also add JSDoc to external types
Changes
astro-coreandastro-runtime. Originally separated because we thought we’d have a lot of types, but after the cleanup it’s not much at all. Combined into oneastrofile.PageorRSS)Testing
Tests should pass
Docs
Docs added in the form of JSDoc for types