michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: Don’t require getCollection() filter to be a type guard (#5998)

Browse source 
Commit dabce6b8c6 (#5970) broke the use
of a plain boolean filter.  Add an overload similar to TypeScript’s
Array#filter overload:

https://github.com/microsoft/TypeScript/blob/v4.9.4/lib/lib.es5.d.ts#L1442-L1453

Signed-off-by: Anders Kaseorg <andersk@mit.edu>

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
This commit is contained in:
Anders Kaseorg 2023-01-26 18:03:09 -08:00 committed by GitHub
parent 5e3d538812
commit 12c68343c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/rotten-dogs-hide.md Normal file
View file

@ -0,0 +1,5 @@
---
"astro": patch
---
Update `getCollection()` filter to support type guards _or_ unknown values

2
packages/astro/src/content/internal.ts
View file

@ -40,7 +40,7 @@ export function createGetCollection({
collectionToEntryMap: CollectionToEntryMap; collectionToEntryMap: CollectionToEntryMap;
collectionToRenderEntryMap: CollectionToEntryMap; collectionToRenderEntryMap: CollectionToEntryMap;
}) { }) {
return async function getCollection(collection: string, filter?: () => boolean) { return async function getCollection(collection: string, filter?: (entry: any) => unknown) {
const lazyImports = Object.values(collectionToEntryMap[collection] ?? {}); const lazyImports = Object.values(collectionToEntryMap[collection] ?? {});
const entries = Promise.all( const entries = Promise.all(
lazyImports.map(async (lazyImport) => { lazyImports.map(async (lazyImport) => {

4
packages/astro/src/content/template/types.d.ts vendored
View file

@ -48,6 +48,10 @@ declare module 'astro:content' {
collection: C, collection: C,
filter?: (entry: CollectionEntry<C>) => entry is E filter?: (entry: CollectionEntry<C>) => entry is E
): Promise<E[]>; ): Promise<E[]>;
export function getCollection<C extends keyof typeof entryMap>(
collection: C,
filter?: (entry: CollectionEntry<C>) => unknown
): Promise<CollectionEntry<C>[]>;
type InferEntrySchema<C extends keyof typeof entryMap> = import('astro/zod').infer< type InferEntrySchema<C extends keyof typeof entryMap> = import('astro/zod').infer<
Required<ContentConfig['collections'][C]>['schema'] Required<ContentConfig['collections'][C]>['schema']