npm.io
2.0.4 • Published 2 years ago

@types/gravatar-favicons

Licence
MIT
Version
2.0.4
Deps
1
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/gravatar-favicons

Summary

This package contains type definitions for gravatar-favicons (https://github.com/bcomnes/gravatar-favicons#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gravatar-favicons.

index.d.ts

import { FaviconOptions } from "favicons";

/**
 * Generate favicons from a gravatar email.
 */
declare function gravatarFavicons(
    config?: gravatarFavicons.Options,
    logger?: gravatarFavicons.Logger,
    cb?: gravatarFavicons.Callback,
): void;

declare namespace gravatarFavicons {
    // console.log compatible contract
    type Logger = (message?: any, ...optionalParams: any[]) => void;

    type Callback = (err: Error | null, files: string[]) => void;

    interface Options {
        email: string;
        dest: string;
        /**
         * The `faviconConfig` field is the same options that can be passed to `favicons`.
         */
        faviconConfig: Partial<FaviconOptions>;
    }
}

export = gravatarFavicons;

Additional Details

Credits

These definitions were written by Piotr Błażejewicz.