DefinitelyTyped/types/polyfill-service/index.d.ts

// Type definitions for polyfill-service 3.25
// Project: https://github.com/financial-times/polyfill-service#readme
// Definitions by: Arturas Molcanovas <https://github.com/Alorel>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

export type PolyfillFlag = 'gated' | 'always';
export type Unknown = 'polyfill' | 'ignore';

export interface Feature {
    flags?: PolyfillFlag[];
}

export interface Features {
    [feature: string]: Feature;
}

export interface GetPolyfillsOptions {
    uaString: string;
    features?: Features;
    excludes?: string[];
}

export interface GetPolyfillStringOptions extends GetPolyfillsOptions {
    minify?: boolean;
    unknown?: Unknown;
}

export interface PolyfillSpec {
    aliasOf?: Set<string>;
    flags: Set<PolyfillFlag>;
}

export interface GetPolyfillsResponse {
    [name: string]: PolyfillSpec;
}

export function listAllPolyfills(): Promise<ReadonlyArray<string>>;

export function getPolyfillString(options: GetPolyfillStringOptions): Promise<string>;

export function getPolyfills(options: GetPolyfillsOptions): Promise<GetPolyfillsResponse>;