Logo for jsDocs.io

favicons

  • Version 7.2.0
  • Published
  • 90.9 kB
  • 3 dependencies
  • MIT license

Install

npm i favicons
yarn add favicons
pnpm add favicons

Overview

Favicon generator for Node.js

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable config

const config: { defaults: FaviconOptions };

    Functions

    function favicons

    favicons: (
        source: string | Buffer | (string | Buffer)[],
        options?: FaviconOptions
    ) => Promise<FaviconResponse>;

      function stream

      stream: (options: FaviconStreamOptions, handleHTML: HandleHTML) => FaviconStream;

        Interfaces

        interface FaviconFile

        interface FaviconFile {}

          property contents

          readonly contents: string;

            property name

            readonly name: string;

              interface FaviconImage

              interface FaviconImage {}

                property contents

                readonly contents: Buffer;

                  property name

                  readonly name: string;

                    interface FaviconOptions

                    interface FaviconOptions {}

                      property appDescription

                      readonly appDescription?: string;

                        property appleStatusBarStyle

                        readonly appleStatusBarStyle?: string;

                          property appName

                          readonly appName?: string;

                            property appShortName

                            readonly appShortName?: string;

                              property background

                              readonly background?: string;

                                property cacheBustingQueryParam

                                readonly cacheBustingQueryParam?: string | null;

                                  property developerName

                                  readonly developerName?: string;

                                    property developerURL

                                    readonly developerURL?: string;

                                      property dir

                                      readonly dir?: string;

                                        property display

                                        readonly display?: string;

                                          property files

                                          readonly files?: Record<PlatformName, FileOptions>;

                                            property icons

                                            readonly icons?: Record<PlatformName, IconOptions | boolean | string[]>;

                                              property lang

                                              readonly lang?: string;

                                                property loadManifestWithCredentials

                                                readonly loadManifestWithCredentials?: boolean;

                                                  property manifestMaskable

                                                  readonly manifestMaskable?: boolean | string | Buffer | (string | Buffer)[];

                                                    property manifestRelativePaths

                                                    readonly manifestRelativePaths?: boolean;

                                                      property orientation

                                                      readonly orientation?: string;

                                                        property output

                                                        readonly output?: OutputOptions;

                                                          property path

                                                          readonly path?: string;

                                                            property pixel_art

                                                            readonly pixel_art?: boolean;

                                                              property preferRelatedApplications

                                                              readonly preferRelatedApplications?: boolean;

                                                                property relatedApplications

                                                                readonly relatedApplications?: Application[];

                                                                  property scope

                                                                  readonly scope?: string;

                                                                    property shortcuts

                                                                    readonly shortcuts?: ShortcutOptions[];

                                                                      property start_url

                                                                      readonly start_url?: string;

                                                                        property theme_color

                                                                        readonly theme_color?: string;

                                                                          property version

                                                                          readonly version?: string;

                                                                            interface FaviconResponse

                                                                            interface FaviconResponse {}

                                                                              property files

                                                                              readonly files: FaviconFile[];

                                                                                property html

                                                                                readonly html: FaviconHtmlElement[];

                                                                                  property images

                                                                                  readonly images: FaviconImage[];

                                                                                    interface FaviconStreamOptions

                                                                                    interface FaviconStreamOptions extends FaviconOptions {}

                                                                                      property emitBuffers

                                                                                      readonly emitBuffers?: boolean;

                                                                                        property html

                                                                                        readonly html?: string;

                                                                                          property pipeHTML

                                                                                          readonly pipeHTML?: boolean;

                                                                                            Type Aliases

                                                                                            type FaviconHtmlElement

                                                                                            type FaviconHtmlElement = string;

                                                                                              type HandleHTML

                                                                                              type HandleHTML = (html: FaviconHtmlElement[]) => void;

                                                                                                Package Files (1)

                                                                                                Dependencies (3)

                                                                                                Dev Dependencies (19)

                                                                                                Peer Dependencies (0)

                                                                                                No peer dependencies.

                                                                                                Badge

                                                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/favicons.

                                                                                                • Markdown
                                                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/favicons)
                                                                                                • HTML
                                                                                                  <a href="https://www.jsdocs.io/package/favicons"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>