Function Option

Option<K>(name): ((_: unknown, _context: ClassAccessorDecoratorContext<{
    application: Application;
} | {
    options: Options;
}, TypeDocOptionValues[K]>) => {
    get(this: {
        application: Application;
    } | {
        options: Options;
    }): 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 TypeDocOptionMap
Parameters
- name: K
Returns ((_: unknown, _context: ClassAccessorDecoratorContext<{
    application: Application;
} | {
    options: Options;
}, TypeDocOptionValues[K]>) => {
    get(this: {
        application: Application;
    } | {
        options: Options;
    }): TypeDocOptionValues[K];
    set(_value: never): never;
})
- - (_, _context): {
        get(this: {
            application: Application;
        } | {
            options: Options;
        }): TypeDocOptionValues[K];
        set(_value: never): never;
    }
  - Parameters
    - _: unknown
    - _context: ClassAccessorDecoratorContext<{
      application: Application;
      } | {
      options: Options;
      }, TypeDocOptionValues[K]>
    Returns {
        get(this: {
            application: Application;
        } | {
            options: Options;
        }): TypeDocOptionValues[K];
        set(_value: never): never;
    }
    - get:function
      - get(this): TypeDocOptionValues[K]
      - Parameters
        this: {
        application: Application;
        } | {
        options: Options;
        }
        Returns TypeDocOptionValues[K]
        Defined in utils/options/options.ts:466
    - set:function
      - set(_value): never
      - Parameters
        _value: never
        Returns never
        Defined in utils/options/options.ts:471
- Defined in utils/options/options.ts:457

Function Option

Type Parameters

Parameters

Returns ((_: unknown, _context: ClassAccessorDecoratorContext<{ application: Application; } | { options: Options; }, TypeDocOptionValues[K]>) => { get(this: { application: Application; } | { options: Options; }): TypeDocOptionValues[K]; set(_value: never): never; })

Parameters

Returns { get(this: { application: Application; } | { options: Options; }): TypeDocOptionValues[K]; set(_value: never): never; }

get:function

Parameters

Returns TypeDocOptionValues[K]

set:function

Parameters

Returns never

Settings

Returns ((_: unknown, _context: ClassAccessorDecoratorContext<{
application: Application;
} | {
options: Options;
}, TypeDocOptionValues[K]>) => {
get(this: {
application: Application;
} | {
options: Options;
}): TypeDocOptionValues[K];
set(_value: never): never;
})

Returns {
get(this: {
application: Application;
} | {
options: Options;
}): TypeDocOptionValues[K];
set(_value: never): never;
}