Skip to main content

publicGenerateOptions

Hierarchy

Index

Properties

Methods

Properties

optionalbail

bail?: boolean

Stop immediately when an error occurred.

components

components: readonly string[]

Glob patterns of component names.

@example
["*"]
@see

pattern

optionalconcurrency

concurrency?: number

Maximum number of concurrent tasks.

@defaultValue

10

optionalextensions

extensions?: readonly string[]

File extensions of components.

@example
["js", "json"]

optionalkeepAjvErrors

keepAjvErrors?: boolean

Do not transform Ajv errors to issues.

path

path: string

Path of the component folder.

optionalthrowOnError

throwOnError?: boolean

Throw an error when an issue with error severity is found.

optionalvalidate

validate?: boolean

Enable validation.

@defaultValue

true

Methods

optionaltransform

  • Transform a manifest. This function is called when a new manifest is found, and before the validation. The return value will override the data of the manifest. If the return value is undefined or null, the manifest will be removed from the result.

    Parameters

    Returns unknown

optionalvalidateAllManifests

  • validateAllManifests(manifests: readonly Manifest[]): void | Promise<void>

  • Validate all manifests after resolving.

    Parameters

    Returns void | Promise<void>

optionalvalidateManifest

  • validateManifest(manifest: Manifest): void | Promise<void>

  • Validate a manifest. This function is called after validate method of a manifest. No matter validate method exists or not, this function will be called.

    If the bail option is true, and validate method failed, this function will not be called.

    Parameters

    Returns void | Promise<void>