Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FaviconsGenerator

Hierarchy

  • FaviconsGenerator
    • FaviconsGenerator

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FaviconsGenerator(config: IConfig, useOffscreenCanvas?: boolean): FaviconsGenerator

Properties

Protected config

config: IConfig

Protected useOffscreenCanvas

useOffscreenCanvas: boolean

Methods

Protected attachMetadata

  • attachMetadata(source: Vinyl): Promise<File>

generateHtmlHeaders

  • generateHtmlHeaders(headersConfig?: IHeadersConfig): IHtmlHeader[]

  • Create HTML-headers for target icons.

    Parameters

    • Optional 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<Vinyl>

  • 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<Vinyl>

Protected generateIcon

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

  • 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<Vinyl>

generateIcons

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

  • Create favicons form sources.

    Parameters

    • source: Vinyl | Vinyl[]

    Returns AsyncGenerator<Vinyl, void, unknown>

    Results of handling.

Protected generateIconsOfType

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

  • Create icons of given type.

    Parameters

    • iconsType: string

      Type of needed icons.

    • sources: Vinyl[]

      Icons sources.

    Returns AsyncGenerator<Vinyl, void, unknown>

    Icons of given type.

generateManifset

  • generateManifset(): IManifestConfig

  • Create full manifest object with icons.

    Returns IManifestConfig

    Manifest object.

Protected getContainSize

  • getContainSize(__namedParameters: { boxHeight: number; boxWidth: number }, __namedParameters: { iconHeight: number; iconWidth: number }): ISize

  • Parameters

    • __namedParameters: { boxHeight: number; boxWidth: number }
      • boxHeight: number
      • boxWidth: number
    • __namedParameters: { iconHeight: number; iconWidth: number }
      • iconHeight: number
      • iconWidth: number

    Returns ISize

Protected getSuitableSourceBuffer

  • getSuitableSourceBuffer(source: Vinyl, width: number, height: number): Promise<Buffer>

Protected renderIcon

  • renderIcon(__namedParameters: [File], config: IRenderConfig): Promise<Buffer>

Protected renderOnCanvas

  • renderOnCanvas(svg: string, desiredWidth: number, desiredHeight: number): Promise<ArrayBuffer>

Protected renderOnOffscreenCanvas

  • renderOnOffscreenCanvas(svg: string, desiredWidth: number, desiredHeight: number): Promise<ArrayBuffer>

Generated using TypeDoc