diff options
| author |  Anders Kaseorg <andersk@mit.edu>
| 2023-01-26 18:03:09 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-01-26 21:03:09 -0500 |
| commit | 12c68343c0aa891037d39d3c9b9378b004be6642 (patch) | |
| tree | 5134f2c6aef6bdf2f59f51bff731ee518fea2382 | |
| parent | 5e3d538812793a952953e7bc1aa65010dd7538fa (diff) | |
| download | astro-12c68343c0aa891037d39d3c9b9378b004be6642.tar.gz astro-12c68343c0aa891037d39d3c9b9378b004be6642.tar.zst astro-12c68343c0aa891037d39d3c9b9378b004be6642.zip | |
fix: Don’t require `getCollection()` filter to be a type guard (#5998)
Commit dabce6b8c684f851c3535f8acead06cbef6dce2a (#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>
| -rw-r--r-- | .changeset/rotten-dogs-hide.md | 5 | ||||
| -rw-r--r-- | packages/astro/src/content/internal.ts | 2 | ||||
| -rw-r--r-- | packages/astro/src/content/template/types.d.ts | 4 |
3 files changed, 10 insertions, 1 deletions
diff --git a/.changeset/rotten-dogs-hide.md b/.changeset/rotten-dogs-hide.md new file mode 100644 index 000000000..b167279aa --- /dev/null +++ b/.changeset/rotten-dogs-hide.md @@ -0,0 +1,5 @@ +--- +"astro": patch +--- + +Update `getCollection()` filter to support type guards _or_ unknown values diff --git a/packages/astro/src/content/internal.ts b/packages/astro/src/content/internal.ts index 8d20aa184..2002aa76d 100644 --- a/packages/astro/src/content/internal.ts +++ b/packages/astro/src/content/internal.ts @@ -40,7 +40,7 @@ export function createGetCollection({ collectionToEntryMap: 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 entries = Promise.all( lazyImports.map(async (lazyImport) => { diff --git a/packages/astro/src/content/template/types.d.ts b/packages/astro/src/content/template/types.d.ts index 628f5d18d..f14a541f1 100644 --- a/packages/astro/src/content/template/types.d.ts +++ b/packages/astro/src/content/template/types.d.ts @@ -48,6 +48,10 @@ declare module 'astro:content' { collection: C, filter?: (entry: CollectionEntry<C>) => entry is 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< Required<ContentConfig['collections'][C]>['schema'] |