summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Michael Rienstra <mrienstra@gmail.com> 2022-11-10 14:54:34 -0800
committerGravatar GitHub <noreply@github.com> 2022-11-10 14:54:34 -0800
commitae41f25e10a3fb1e5ad72c979ebe27fe55071de3 (patch)
tree02d14d8d452ad38e37fcc3c96bd5d8425a4ed129
parentedfbb0c9dde9c106fffdadca4861c11ca25517c6 (diff)
downloadastro-ae41f25e10a3fb1e5ad72c979ebe27fe55071de3.tar.gz
astro-ae41f25e10a3fb1e5ad72c979ebe27fe55071de3.tar.zst
astro-ae41f25e10a3fb1e5ad72c979ebe27fe55071de3.zip
Consistent MD frontmatter typing (#5294)
* consistent MD frontmatter typing * changeset
-rw-r--r--.changeset/thin-trains-complain.md5
-rw-r--r--packages/astro/src/@types/astro.ts10
2 files changed, 11 insertions, 4 deletions
diff --git a/.changeset/thin-trains-complain.md b/.changeset/thin-trains-complain.md
new file mode 100644
index 000000000..f7477f21a
--- /dev/null
+++ b/.changeset/thin-trains-complain.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Consistent Markdown frontmatter typing (`MarkdownAstroData["frontmatter"]` in particular was `object` before)
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index bf91d6e4d..d24b194c8 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -1005,6 +1005,8 @@ export interface MarkdownInstance<T extends Record<string, any>> {
default: AstroComponentFactory;
}
+type MD = MarkdownInstance<Record<string, any>>;
+
export interface MDXInstance<T extends Record<string, any>>
extends Omit<MarkdownInstance<T>, 'rawContent' | 'compiledContent'> {
/** MDX does not support rawContent! If you need to read the Markdown contents to calculate values (ex. reading time), we suggest injecting frontmatter via remark plugins. Learn more on our docs: https://docs.astro.build/en/guides/integrations-guide/mdx/#inject-frontmatter-via-remark-or-rehype-plugins */
@@ -1083,9 +1085,7 @@ export interface ManifestData {
}
export interface MarkdownParserResponse extends MarkdownRenderingResult {
- frontmatter: {
- [key: string]: any;
- };
+ frontmatter: MD['frontmatter'];
}
/**
@@ -1410,7 +1410,9 @@ export interface SSRResult {
_metadata: SSRMetadata;
}
-export type MarkdownAstroData = { frontmatter: object };
+export type MarkdownAstroData = {
+ frontmatter: MD['frontmatter'];
+};
/* Preview server stuff */
export interface PreviewServer {