@knodes/typedoc-pluginutils/dist/options/option-group.d.ts

A set of utilities for TypeDoc plugins

import { DeclarationOption } from 'typedoc';
import { MapperPart } from './option';
import { DeclarationOptionConfig, ParameterValueType, TypeErr } from './utils';
import type { ABasePlugin } from '../base-plugin';
interface Builder<T extends Record<string, any>, TDecs extends Record<never, DeclarationOption>> {
    add: <K extends keyof T & Exclude<keyof T, keyof TDecs>, TDec extends DeclarationOptionConfig<DeclarationOption>>(name: K, declaration: TDec, ...mapper: MapperPart<T[K], TDec>) => Builder<T, TDecs & {
        [k in K]: TDec & {
            name: K;
        };
    }>;
    build: [Exclude<keyof T, keyof TDecs>] extends [never] ? TDecs extends Record<keyof T, DeclarationOptionConfig> ? () => OptionGroup<T, {
        [k in keyof TDecs]: TDecs[k] & DeclarationOption;
    }> : TypeErr<['Invalid case']> : TypeErr<['Missing declarations for keys', Exclude<keyof T, keyof TDecs>]>;
}
type OptionGroupSetValue<TDeclarations extends Record<string, DeclarationOptionConfig>> = {
    [k in keyof TDeclarations]?: ParameterValueType<TDeclarations[k]>;
};
export declare class OptionGroup<T extends Record<string, any>, TDeclarations extends {
    [k in keyof T]: DeclarationOptionConfig;
} = {
    [k in keyof T]: DeclarationOptionConfig;
}> {
    readonly plugin: ABasePlugin;
    private readonly _options;
    /**
     * Generate a type-helper factory to constraint the option to be of the given {@link T2 type}.
     *
     * TODO: change signature once https://github.com/microsoft/TypeScript/pull/26349 is merged.
     *
     * @param plugin - The plugin declaring the option.
     * @returns a builder to use in order to generate the full option group.
     */
    static factory<T2 extends Record<never, unknown>>(plugin: ABasePlugin): Builder<T2, Record<never, DeclarationOption>>;
    /**
     * Create the actual option builder.
     *
     * @param plugin - The plugin declaring the option.
     * @param decs - The declarations so far.
     * @param mappers - The mappers so far.
     * @returns the builder to chain.
     */
    private static _build;
    private get _rootOption();
    constructor(plugin: ABasePlugin, optionDeclarations: TDeclarations, mappers: {
        [k in keyof T]: (v: any) => T[k];
    });
    /**
     * Get the mapped values.
     *
     * @returns the group values.
     */
    getValue(): T;
    /**
     * Set the raw values.
     *
     * @param value - The value to set. Paths, JSON & partial options are authorized
     */
    setValue(value: OptionGroupSetValue<TDeclarations> | string): void;
    setValue<TK extends keyof TDeclarations>(key: TK, value: ParameterValueType<TDeclarations[TK]>): void;
    setValue(...args: [OptionGroupSetValue<TDeclarations> | string] | [key: keyof TDeclarations, value: ParameterValueType<TDeclarations[keyof TDeclarations]>]): void;
    /**
     * Set the raw values.
     *
     * @param value - The value to set. Paths, JSON & partial options are authorized.
     * @returns nothing.
     */
    private _setValue;
    /**
     * Set the raw values from a POJO.
     *
     * @param value - The values to set as object.
     */
    private _setValueFromObject;
    /**
     * Load the given file as being the full plugin options.
     *
     * @param filename - The file containing options. Any `require`able file can be provided.
     */
    private _setValueFromFile;
    /**
     * Try loading different options sources, and update plugin options with default values if not set.
     */
    private _onBeforeOptionsFreeze;
    /**
     * Execute a {@link cb callback} on each declared options, & return an object containing the resulting values.
     *
     * @param cb - The function to execute on each option. Called with the key & the {@link Option}.
     * @returns the mapped values.
     */
    private _mapOptions;
}
export {};
//# sourceMappingURL=option-group.d.ts.map