fix(astro:content): add deprecated to getEntryBySlug & `getDataEntr…

…yById` (#11600) Co-authored-by: Chris Swithinbank <[email protected]>
withastro · Aug 2, 2024 · 09ec2ca · 09ec2ca
1 parent 1b3c81c
commit 09ec2ca
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.changeset/dull-taxis-warn.md b/.changeset/dull-taxis-warn.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Deprecates `getEntryBySlug` and `getDataEntryById` functions exported by `astro:content` in favor of `getEntry`.
diff --git a/packages/astro/templates/content/types.d.ts b/packages/astro/templates/content/types.d.ts
@@ -22,6 +22,7 @@ declare module 'astro:content' {
 		ContentEntryMap[C]
 	>['slug'];
 
+	/** @deprecated Use `getEntry` instead. */
 	export function getEntryBySlug<
 		C extends keyof ContentEntryMap,
 		E extends ValidContentEntrySlug<C> | (string & {}),
@@ -33,6 +34,7 @@ declare module 'astro:content' {
 		? Promise<CollectionEntry<C>>
 		: Promise<CollectionEntry<C> | undefined>;
 
+	/** @deprecated Use `getEntry` instead. */
 	export function getDataEntryById<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C]>(
 		collection: C,
 		entryId: E