Sitelet https://gro.fuz.dev/docs/api/modules.ts#LoadModuleResult

modules.ts

view source

Declarations
#

7 declarations

load_module
#

modules.ts view source

<TModule extends Record<string, any>>(id: PathId, validate?: ((mod: Record<string, any>) => mod is TModule) | undefined, bust_cache?: boolean | undefined): Promise<LoadModuleResult<TModule>> import {load_module} from '@fuzdev/gro/modules.js';

id

type PathId

validate?

type (mod: Record<string, any>) => mod is TModule
optional

bust_cache?

type boolean
optional

returns

Promise<LoadModuleResult>

generics

load_module<TModule extends Record<string, any>>
TModule
constraint Record<string, any>

load_modules
#

modules.ts view source

<TModule extends Record<string, any>, TModuleMeta extends ModuleMeta<TModule>>(resolved_input_files: ResolvedInputFile[], validate: (mod: any) => mod is TModule, map_module_meta: (resolved_input_file: ResolvedInputFile, mod: TModule) => TModuleMeta, timings?: Timings | undefined): Promise<...> import {load_modules} from '@fuzdev/gro/modules.js';

resolved_input_files

type ResolvedInputFile[]

validate

type (mod: any) => mod is TModule

map_module_meta

type (resolved_input_file: ResolvedInputFile, mod: TModule) => TModuleMeta

timings?

type Timings
optional

returns

Promise<LoadModulesResult>

generics

load_modules<TModule extends Record<string, any>, TModuleMeta extends ModuleMeta<TModule>>
TModule
constraint Record<string, any>
TModuleMeta
constraint ModuleMeta<TModule>

LoadModuleFailure
#

modules.ts view source

LoadModuleFailure

type { ok: false; type: "failed_import"; id: PathId; error: Error; } | { ok: false; type: "failed_validation"; id: PathId; mod: Record<string, any>; validation: string; }

import type {LoadModuleFailure} from '@fuzdev/gro/modules.js';

LoadModuleResult
#

modules.ts view source

LoadModuleResult<TModule>

type ({ ok: true; } & { id: PathId; mod: TModule; }) | (({ ok: false; } & { ok: false; type: "failed_import"; id: PathId; error: Error; }) | ({ ok: false; } & { ok: false; type: "failed_validation"; id: PathId; mod: Record<string, any>; validation: string; }))

import type {LoadModuleResult} from '@fuzdev/gro/modules.js';

generics

LoadModuleResult<TModule>
TModule

LoadModulesFailure
#

modules.ts view source

LoadModulesFailure<TModuleMeta> import type {LoadModulesFailure} from '@fuzdev/gro/modules.js';

generics

LoadModulesFailure<TModuleMeta extends ModuleMeta>
TModuleMeta
constraint ModuleMeta

type

type "load_module_failures"

load_module_failures

type LoadModuleFailure[]

reasons

type string[]

modules

type TModuleMeta[]

LoadModulesResult
#

modules.ts view source

LoadModulesResult<TModuleMeta>

type ({ ok: true; } & { modules: TModuleMeta[]; }) | ({ ok: false; } & LoadModulesFailure<TModuleMeta>)

import type {LoadModulesResult} from '@fuzdev/gro/modules.js';

generics

LoadModulesResult<TModuleMeta extends ModuleMeta>
TModuleMeta
constraint ModuleMeta

ModuleMeta
#

modules.ts view source

ModuleMeta<TModule> import type {ModuleMeta} from '@fuzdev/gro/modules.js';

generics

ModuleMeta<TModule extends Record<string, any> = Record<string, any>>
TModule
constraint Record<string, any>
default Record<string, any>

id

type PathId

mod

type TModule

Depends on
#

Imported by
#