Class FaviconsGenerator

Hierarchy

FaviconsGenerator
- FaviconsGenerator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FaviconsGenerator(__namedParameters?: { icons: IIconsConfig; manifest: IManifestConfig; path: string }): FaviconsGenerator

Inherited from FaviconsGenerator.constructor
- Defined in src/FaviconsGenerator.ts:48
Parameters
- Default value __namedParameters: { icons: IIconsConfig; manifest: IManifestConfig; path: string } = {}
  - icons: IIconsConfig
  - manifest: IManifestConfig
  - path: string
Returns FaviconsGenerator

Properties

Protected attachMetadata

attachMetadata: attachMetadata = attachMetadata

Protected Readonly config

config: IConfig

Protected renderIcon

renderIcon: renderIcon = renderIcon

Methods

generateHtmlHeaders

generateHtmlHeaders(headersConfig?: IHeadersConfig): IHtmlHeader[]

Inherited from FaviconsGenerator.generateHtmlHeaders
- Defined in src/FaviconsGenerator.ts:146
Create HTML-headers for target icons.

Parameters
- Default value headersConfig: IHeadersConfig = {}
  
  Custom headers config.
Returns IHtmlHeader[]

Array of headers objects. You can get HTML-markup with getHtmlHeadersMarkup helper.

Protected generateIco

generateIco(filename: string, sources: Vinyl[], iconConfig: IIconConfig, iconToGenerateConfig: IIconToGenerateConfig): Promise<File>

Inherited from FaviconsGenerator.generateIco
- Defined in src/FaviconsGenerator.ts:249
Create ".ico" icon.

Parameters
- filename: string
  
  File name of icon.
- sources: Vinyl[]
  
  Sources of icon.
- iconConfig: IIconConfig
  
  Icon config.
- iconToGenerateConfig: IIconToGenerateConfig
  
  Icon to generate config.
Returns Promise<File>

Protected generateIcon

generateIcon(filename: string, sources: Vinyl[], iconConfig: IIconConfig, iconToGenerateConfig: IIconToGenerateConfig): Promise<File>

Inherited from FaviconsGenerator.generateIcon
- Defined in src/FaviconsGenerator.ts:203
Create icon.

Parameters
- filename: string
  
  File name of icon.
- sources: Vinyl[]
  
  Sources of icon.
- iconConfig: IIconConfig
  
  Icon config.
- iconToGenerateConfig: IIconToGenerateConfig
  
  Icon to generate config.
Returns Promise<File>

generateIcons

generateIcons(source: Vinyl | Vinyl[]): AsyncGenerator<File, void, unknown>

Inherited from FaviconsGenerator.generateIcons
- Defined in src/FaviconsGenerator.ts:73
Create favicons form sources.

Parameters
- source: Vinyl | Vinyl[]
Returns AsyncGenerator<File, void, unknown>

Results of handling.

Protected generateIconsOfType

generateIconsOfType(iconsType: string, sources: Vinyl[]): AsyncGenerator<File, void, unknown>

Inherited from FaviconsGenerator.generateIconsOfType
- Defined in src/FaviconsGenerator.ts:172
Create icons of given type.

Parameters
- iconsType: string
  
  Type of needed icons.
- sources: Vinyl[]
  
  Icons sources.
Returns AsyncGenerator<File, void, unknown>

Icons of given type.

generateManifset

generateManifset(): IManifestConfig

Inherited from FaviconsGenerator.generateManifset
- Defined in src/FaviconsGenerator.ts:116
Create full manifest object with icons.

Returns IManifestConfig

Manifest object.

Generated using TypeDoc