Skip to main content

Type Alias: SideEffectFunction()<TFinalSettings>

SideEffectFunction<TFinalSettings> = (templateSettings, oldFileContents?) => Promise<string | null>

Defined in: ../../template-types-lib/src/types/template-config-types.ts:57

Type representing a function that has side effects when generating a template.

Type Parameters​

TFinalSettings​

TFinalSettings extends FinalTemplateSettings = FinalTemplateSettings

Parameters​

templateSettings​

TFinalSettings

The template settings the user inputted when generating the template.

oldFileContents?​

string

The old contents of the file to be edited, if any.

Returns​

Promise<string | null>

The new contents of the file.