publicResolveOptions

Index

Properties

• bail
• concurrency
• index
• keepAjvErrors
• path
• throwOnError
• validate

Methods

• transform
• validateManifest

Properties

optionalbail

bail?: boolean

Stop immediately when an error occurred.

optionalconcurrency

concurrency?: number

Maximum number of concurrent tasks.

@defaultValue

10

optionalindex

index?: number[]

Source index of a manifest.

@defaultValue

[]

optionalkeepAjvErrors

keepAjvErrors?: boolean

Do not transform Ajv errors to issues.

optionalpath

path?: string

Source path of a manifest.

@defaultValue

""

optionalthrowOnError

throwOnError?: boolean

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

optionalvalidate

validate?: boolean

Enable validation.

@defaultValue

true

Methods

optionaltransform

• transform(manifest: Manifest): unknown

• 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

  • manifest: Manifest

  Returns unknown

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

  • manifest: Manifest

  Returns void | Promise<void>