Function Option

Option<K extends keyof Configuration.TypeDocOptionMap>(
    name: K,
): (
    _: unknown,
    _context: ClassAccessorDecoratorContext<
        { application: Application }
        | { options: Configuration.Options },
        Configuration.TypeDocOptionValues[K],
    >,
) => {
    get(
        this: { application: Application } | { options: Configuration.Options },
    ): Configuration.TypeDocOptionValues[K];
    set(_value: never): never;
}
Binds an option to an accessor. Does not register the option.

Note: This is a standard ES decorator. It will not work with pre-TS 5.0 experimental decorators enabled.
Type Parameters
- K extends keyof Configuration.TypeDocOptionMap
Parameters
- name: K
Returns (
    _: unknown,
    _context: ClassAccessorDecoratorContext<
        { application: Application }
        | { options: Configuration.Options },
        Configuration.TypeDocOptionValues[K],
    >,
) => {
    get(
        this: { application: Application } | { options: Configuration.Options },
    ): Configuration.TypeDocOptionValues[K];
    set(_value: never): never;
}
- Defined in lib/utils/options/options.ts:461