vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-06-02 01:20:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[@types/favicons]: add missing options (#40920)

Browse Source
This commit is contained in:
Artur
2019-12-20 08:53:31 +02:00
committed by Daniel Rosenwasser
parent 8be221da22
commit e3e59c5d4e
2 changed files with 58 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
types/favicons/favicons-tests.ts
View File

@@ -6,7 +6,10 @@ let config: Partial<favicons.Configuration> = {
config = {
icons: {
android: true
android: true,
favicons: {
ovelayShadow: false
}
}
};

83
types/favicons/index.d.ts vendored
View File

@@ -1,45 +1,67 @@
// Type definitions for favicons 5.3
// Type definitions for favicons 5.5
// Project: https://github.com/itgalaxy/favicons
// Definitions by: Mohsen Azimi <https://github.com/mohsen1>, Nikk Radetskiy <https://github.com/metsawyr>
// Definitions by: Mohsen Azimi <https://github.com/mohsen1>
// Nikk Radetskiy <https://github.com/metsawyr>
// Artur Androsovych <https://github.com/arturovt>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1
/// <reference types="node" />
import { Duplex } from "stream";
import { Duplex } from 'stream';
declare namespace favicons {
interface IconOptions {
offset?: number;
background?: boolean | string;
mask?: boolean;
overlayGlow?: boolean;
ovelayShadow?: boolean;
}
interface Configuration {
/** Path for overriding default icons path @default "/" */
/** Path for overriding default icons path @default '/' */
path: string;
/** Your application's name @default null */
appName: string | null;
/** Your application's short_name. If not set, `appName` will be used @default null */
appShortName: string | null;
/** Your application's description @default null */
appDescription: string | null;
/** Your (or your developer's) name @default null */
developerName: string | null;
/** Your (or your developer's) URL @default null */
developerURL: string | null;
/** Primary text direction for name, short_name, and description @default "auto" */
/** Primary text direction for name, short_name, and description @default 'auto' */
dir: string;
/** Primary language for name and short_name @default "en-US */
/** Primary language for name and short_name @default 'en-US' */
lang: string;
/** Background colour for flattened icons @default "#fff" */
/** Background colour for flattened icons @default '#fff' */
background: string;
/** Theme color user for example in Android's task switcher @default "#fff" */
/** Theme color user for example in Android's task switcher @default '#fff' */
theme_color: string;
/** Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser" @default "standalone" */
display: "fullscreen" | "standalone" | "minimal-ui" | "browser";
/** Default orientation: "any", "natural", "portrait" or "landscape" @default "any" */
orientation: "any" | "natural" | "portrait" | "landscape";
/** Start URL when launching the application from a device @default "/?homescreen=1" */
/** Style for Apple status bar @default 'black-translucent' */
appleStatusBarStyle: 'black-translucent' | 'default' | 'black';
/** Preferred display mode: 'fullscreen', 'standalone', 'minimal-ui' or 'browser' @default 'standalone' */
display: 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser';
/** Default orientation: 'any', 'natural', 'portrait' or 'landscape' @default 'any' */
orientation: 'any' | 'natural' | 'portrait' | 'landscape';
/** Set of URLs that the browser considers within your app @default null */
scope: string;
/** Start URL when launching the application from a device @default '/?homescreen=1' */
start_url: string;
/** Your application's version string @default "1.0" */
/** Your application's version string @default '1.0' */
version: string;
/** Print logs to console? @default false */
logging: boolean;
/** Determines whether to allow piping html as a file @default false */
pipeHTML: boolean;
/** Use nearest neighbor resampling to preserve hard edges on pixel art @default false */
pixel_art: boolean;
/** Browsers don't send cookies when fetching a manifest, enable this to fix that @default false */
loadManifestWithCredentials: boolean;
/** Determines whether to set relative paths in manifests @default false */
manifestRelativePaths: boolean;
/**
* Platform Options:
* - offset - offset in percentage
@@ -47,24 +69,27 @@ declare namespace favicons {
* * false - use default
* * true - force use default, e.g. set background for Android icons
* * color - set background for the specified icons
* - mask - apply mask in order to create circle icon (applied by default for firefox)
* - overlayGlow - apply glow effect after mask has been applied (applied by default for firefox)
* - overlayShadow - apply drop shadow after mask has been applied
*/
icons: Partial<{
/* Create Android homescreen icon. */
android: boolean | { offset: string; background: string };
/* Create Apple touch icons. */
appleIcon: boolean | { offset: string; background: string };
/* Create Apple startup images. */
appleStartup: boolean | { offset: string; background: string };
/* Create Opera Coast icon. */
coast: boolean | { offset: string; background: string };
/* Create regular favicons. */
favicons: boolean;
/* Create Firefox OS icons. */
firefox: boolean | { offset: string; background: string };
/* Create Windows 8 tile icons. */
windows: boolean | { background: string };
/* Create Android homescreen icon. */
android: boolean | IconOptions;
/* Create Apple touch icons. */
appleIcon: boolean | IconOptions;
/* Create Apple startup images. */
appleStartup: boolean | IconOptions;
/* Create Opera Coast icon. */
coast: boolean | IconOptions;
/* Create regular favicons. */
favicons: boolean | IconOptions;
/* Create Firefox OS icons. */
firefox: boolean | IconOptions;
/* Create Windows 8 tile icons. */
windows: boolean | IconOptions;
/* Create Yandex browser icon. */
yandex: boolean | { background: string };
yandex: boolean | IconOptions;
}>;
}