Type alias HTMLGeneratorOptions

HTMLGeneratorOptions: {
    configKeys: string[];
    deleteTemplateAfter: boolean;
    file: string;
    placeholderExpression: RegExp;
    replacePlaceholder: string | RegExp;
    silent: boolean;
    template: string;
    variableName: string;
}

The options to customize a HTMLGenerator instance.

Type declaration

  • configKeys: string[]

    A list of settings from the app configuration that will be used as the information to inject on the file.

    Default

    ['features', 'version', 'postMessagesPrefix']
    
  • deleteTemplateAfter: boolean

    Whether or not to delete the tempalte after generating the file.

    Default

    true
    
  • file: string

    The name of the generated file.

    Default

    'index.html'
    
  • placeholderExpression: RegExp

    A regular expression for dynamic placeholders that will be replaced by values when the file is generated.

    Default

    /{{(.*?)}}/gi
    
  • replacePlaceholder: string | RegExp

    The placeholder string where the information will be written.

    Default

    /{{appConfi(?:guration)?}}/
    
  • silent: boolean

    If true, it won't log messages on the terminal when generating the file.

    Default

    false
    
  • template: string

    The name of the file it should use as template.

    Default

    'index.tpl.html'
    
  • variableName: string

    The name of the variable that will have the information on the file.

    Default

    'appConfig'
    

Generated using TypeDoc