From 7641ca8c13271888bad4aac33703a5e08467bb94 Mon Sep 17 00:00:00 2001 From: bluwy Date: Tue, 16 Aug 2022 23:43:29 +0800 Subject: [PATCH 1/2] docs: update import.meta.glob jsdocs --- packages/vite/types/importGlob.d.ts | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/packages/vite/types/importGlob.d.ts b/packages/vite/types/importGlob.d.ts index 6bb03fe9943a93..984007f142f811 100644 --- a/packages/vite/types/importGlob.d.ts +++ b/packages/vite/types/importGlob.d.ts @@ -38,7 +38,9 @@ export interface KnownAsTypeMap { export interface ImportGlobFunction { /** - * 1. No generic provided, infer the type from `eager` and `as` + * Import a list of files with a glob pattern. + * + * Overload 1: No generic provided, infer the type from `eager` and `as` */ < Eager extends boolean, @@ -51,14 +53,18 @@ export interface ImportGlobFunction { ? Record : Record Promise> /** - * 2. Module generic provided, infer the type from `eager: false` + * Import a list of files with a glob pattern. + * + * Overload 2: Module generic provided, infer the type from `eager: false` */ ( glob: string | string[], options?: ImportGlobOptions ): Record Promise> /** - * 3. Module generic provided, infer the type from `eager: true` + * Import a list of files with a glob pattern. + * + * Overload: 3 Module generic provided, infer the type from `eager: true` */ ( glob: string | string[], @@ -68,7 +74,9 @@ export interface ImportGlobFunction { export interface ImportGlobEagerFunction { /** - * 1. No generic provided, infer the type from `as` + * Eagerly import a list of files with a glob pattern. + * + * Overload 1: No generic provided, infer the type from `as` */ < As extends string, @@ -78,7 +86,9 @@ export interface ImportGlobEagerFunction { options?: Omit, 'eager'> ): Record /** - * 2. Module generic provided + * Eagerly import a list of files with a glob pattern. + * + * Overload 2: Module generic provided */ ( glob: string | string[], From 6e1de0c832d3294945de4724bb823da5706ae9e0 Mon Sep 17 00:00:00 2001 From: Bjorn Lu Date: Tue, 16 Aug 2022 23:55:24 +0800 Subject: [PATCH 2/2] docs: typo --- packages/vite/types/importGlob.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/vite/types/importGlob.d.ts b/packages/vite/types/importGlob.d.ts index 984007f142f811..321e3804a7e09a 100644 --- a/packages/vite/types/importGlob.d.ts +++ b/packages/vite/types/importGlob.d.ts @@ -64,7 +64,7 @@ export interface ImportGlobFunction { /** * Import a list of files with a glob pattern. * - * Overload: 3 Module generic provided, infer the type from `eager: true` + * Overload 3: Module generic provided, infer the type from `eager: true` */ ( glob: string | string[],