gen.ts

view source

Declarations
#

36 declarations

analyze_gen_result
#

gen.ts view source

(file: GenFile): Promise<AnalyzedGenResult> import {analyze_gen_result} from '@fuzdev/gro/gen.js';

`file`

type GenFile

returns

Promise<AnalyzedGenResult>

analyze_gen_results
#

gen.ts view source

(gen_results: GenResults): Promise<AnalyzedGenResult[]> import {analyze_gen_results} from '@fuzdev/gro/gen.js';

`gen_results`

type GenResults

returns

Promise<AnalyzedGenResult[]>

AnalyzedGenResult
#

gen.ts view source

AnalyzedGenResult import type {AnalyzedGenResult} from '@fuzdev/gro/gen.js';

find_genfiles
#

gen.ts view source

(input_paths: InputPath[], root_dirs: PathId[], config: GroConfig, timings?: Timings | undefined): Promise<FindGenfilesResult>

import {find_genfiles} from '@fuzdev/gro/gen.js';

Finds modules from input paths. (see input_path.ts for more)

`input_paths`

type InputPath[]

`root_dirs`

type PathId[]

`config`

type GroConfig

`timings?`

type Timings | undefined

optional

returns

Promise<FindGenfilesResult>

FindGenfilesFailure
#

gen.ts view source

FindGenfilesFailure import type {FindGenfilesFailure} from '@fuzdev/gro/gen.js';

FindGenfilesResult
#

gen.ts view source

FindGenfilesResult import type {FindGenfilesResult} from '@fuzdev/gro/gen.js';

FoundGenfiles
#

gen.ts view source

FoundGenfiles import type {FoundGenfiles} from '@fuzdev/gro/gen.js';

`resolved_input_files`

type Array<ResolvedInputFile>

`resolved_input_files_by_root_dir`

type Map<PathId, Array<ResolvedInputFile>>

`resolved_input_paths`

type Array<ResolvedInputPath>

Gen
#

gen.ts view source

Gen import type {Gen} from '@fuzdev/gro/gen.js';

GEN_FILE_PATTERN
#

gen.ts view source

string import {GEN_FILE_PATTERN} from '@fuzdev/gro/gen.js';

GEN_FILE_PATTERN_TEXT
#

gen.ts view source

"gen" import {GEN_FILE_PATTERN_TEXT} from '@fuzdev/gro/gen.js';

GenConfig
#

gen.ts view source

GenConfig import type {GenConfig} from '@fuzdev/gro/gen.js';

GenContext import type {GenContext} from '@fuzdev/gro/gen.js';

`config`

type GroConfig

`svelte_config`

type ParsedSvelteConfig

`filer`

type Filer

`log`

type Logger

`timings`

type Timings

`invoke_task`

type InvokeTask

`origin_id`

Same as import.meta.url but in path form.

type PathId

`origin_path`

The origin_id relative to the root dir.

type string

`changed_file_id`

The file that triggered dependency checking. Only available when resolving dependencies dynamically. undefined during actual generation.

type PathId | undefined

GenDependencies
#

gen.ts view source

GenDependencies import type {GenDependencies} from '@fuzdev/gro/gen.js';

GenDependenciesConfig
#

gen.ts view source

GenDependenciesConfig import type {GenDependenciesConfig} from '@fuzdev/gro/gen.js';

`patterns?`

type Array<RegExp>

`files?`

type Array<PathId>

GenDependenciesResolver
#

gen.ts view source

GenDependenciesResolver import type {GenDependenciesResolver} from '@fuzdev/gro/gen.js';

`(call)`

`ctx`

type GenContext

GenFile
#

gen.ts view source

GenFile import type {GenFile} from '@fuzdev/gro/gen.js';

`id`

type PathId

`content`

type string

`origin_id`

type PathId

`format`

type boolean

GenfileModule
#

gen.ts view source

GenfileModule import type {GenfileModule} from '@fuzdev/gro/gen.js';

`gen`

type Gen

GenfileModuleMeta
#

gen.ts view source

GenfileModuleMeta import type {GenfileModuleMeta} from '@fuzdev/gro/gen.js';

GenfileModuleResult
#

gen.ts view source

GenfileModuleResult import type {GenfileModuleResult} from '@fuzdev/gro/gen.js';

GenfileModuleResultFailure
#

gen.ts view source

GenfileModuleResultFailure import type {GenfileModuleResultFailure} from '@fuzdev/gro/gen.js';

`ok`

type false

`id`

type PathId

`reason`

type string

`error`

type Error

`elapsed`

type number

GenfileModuleResultSuccess
#

gen.ts view source

GenfileModuleResultSuccess import type {GenfileModuleResultSuccess} from '@fuzdev/gro/gen.js';

`ok`

type true

`id`

type PathId

`files`

type Array<GenFile>

`elapsed`

type number

GenFunction
#

gen.ts view source

GenFunction import type {GenFunction} from '@fuzdev/gro/gen.js';

`(call)`

type (ctx: GenContext): RawGenResult | Promise<RawGenResult>

`ctx`

type GenContext

returns RawGenResult | Promise<RawGenResult>

GenResult
#

gen.ts view source

GenResult import type {GenResult} from '@fuzdev/gro/gen.js';

`origin_id`

type PathId

`files`

type Array<GenFile>

GenResults
#

gen.ts view source

GenResults import type {GenResults} from '@fuzdev/gro/gen.js';

`results`

type Array<GenfileModuleResult>

`successes`

type Array<GenfileModuleResultSuccess>

`failures`

type Array<GenfileModuleResultFailure>

`input_count`

type number

`output_count`

type number

`elapsed`

type number

is_gen_path
#

gen.ts view source

(path: string): boolean import {is_gen_path} from '@fuzdev/gro/gen.js';

`path`

type string

returns

boolean

load_genfiles
#

gen.ts view source

(found_genfiles: FoundGenfiles, timings?: Timings | undefined): Promise<LoadGenfilesResult> import {load_genfiles} from '@fuzdev/gro/gen.js';

`found_genfiles`

type FoundGenfiles

`timings?`

type Timings | undefined

optional

returns

Promise<LoadGenfilesResult>

LoadedGenfiles
#

gen.ts view source

LoadedGenfiles import type {LoadedGenfiles} from '@fuzdev/gro/gen.js';

`modules`

type Array<GenfileModuleMeta>

`found_genfiles`

type FoundGenfiles

LoadGenfilesFailure
#

gen.ts view source

LoadGenfilesFailure import type {LoadGenfilesFailure} from '@fuzdev/gro/gen.js';

LoadGenfilesResult
#

gen.ts view source

LoadGenfilesResult import type {LoadGenfilesResult} from '@fuzdev/gro/gen.js';

normalize_gen_config
#

gen.ts view source

(gen: Gen): GenConfig import {normalize_gen_config} from '@fuzdev/gro/gen.js';

`gen`

type Gen

returns

GenConfig

RawGenFile
#

gen.ts view source

RawGenFile import type {RawGenFile} from '@fuzdev/gro/gen.js';

`content`

type string

`filename?`

type string

`format?`

type boolean

RawGenResult
#

gen.ts view source

RawGenResult import type {RawGenResult} from '@fuzdev/gro/gen.js';

to_gen_result
#

gen.ts view source

(origin_id: PathId, raw_result: RawGenResult): GenResult import {to_gen_result} from '@fuzdev/gro/gen.js';

`origin_id`

type PathId

`raw_result`

type RawGenResult

returns

GenResult

to_output_file_name
#

gen.ts view source

(filename: string): string import {to_output_file_name} from '@fuzdev/gro/gen.js';

`filename`

type string

returns

string

validate_gen_module
#

gen.ts view source

(mod: Record<string, any>): mod is GenfileModule import {validate_gen_module} from '@fuzdev/gro/gen.js';

`mod`

type Record<string, any>

returns

boolean

write_gen_results
#

gen.ts view source

(gen_results: GenResults, analyzed_gen_results: AnalyzedGenResult[], log: Logger): Promise<void> import {write_gen_results} from '@fuzdev/gro/gen.js';

`gen_results`

type GenResults

`analyzed_gen_results`

type AnalyzedGenResult[]

`log`

type Logger

returns

Promise<void>

file

returns

gen_results

returns

input_paths

root_dirs

config

timings?

returns

resolved_input_files

resolved_input_files_by_root_dir

resolved_input_paths

generate

dependencies?

config

svelte_config

filer

log

timings

invoke_task

origin_id

origin_path

changed_file_id

patterns?

files?

(call)

ctx

id

content

origin_id

format

gen

ok

id

reason

error

elapsed

ok

id

files

elapsed

(call)

ctx

origin_id

files

results

successes

failures

input_count

output_count

elapsed

path

returns

found_genfiles

timings?

returns

modules

found_genfiles

gen

returns

content

filename?

format?

origin_id

raw_result

returns

filename

returns

mod

returns

gen_results

analyzed_gen_results

log

returns

`file`

`gen_results`

`input_paths`

`root_dirs`

`config`

`timings?`

`resolved_input_files`

`resolved_input_files_by_root_dir`

`resolved_input_paths`

`generate`

`dependencies?`

`config`

`svelte_config`

`filer`

`log`

`timings`

`invoke_task`

`origin_id`

`origin_path`

`changed_file_id`

`patterns?`

`files?`

`(call)`

`ctx`

`id`

`content`

`origin_id`

`format`

`gen`

`ok`

`id`

`reason`

`error`

`elapsed`

`ok`

`id`

`files`

`elapsed`

`(call)`

`ctx`

`origin_id`

`files`

`results`

`successes`

`failures`

`input_count`

`output_count`

`elapsed`

`path`

`found_genfiles`

`timings?`

`modules`

`found_genfiles`

`gen`

`content`

`filename?`

`format?`

`origin_id`

`raw_result`

`filename`

`mod`

`gen_results`

`analyzed_gen_results`

`log`