Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export Docusaurus plugin options type #440

Closed
PatrikTrefil opened this issue May 26, 2023 · 2 comments
Closed

Export Docusaurus plugin options type #440

PatrikTrefil opened this issue May 26, 2023 · 2 comments
Labels
next Fix available in the '@next' release

Comments

@PatrikTrefil
Copy link

Could you also export the type of the plugin options of Docusaurus so it could be used with JSDoc like this?

/** @type {import('@docusaurus/types').Config} */
const config = {
    plugins: [
        [
            "docusaurus-plugin-typedoc",
            /** @type {import("docusaurus-plugin-typedoc").PluginOptions} */
            {
                entryPoints: [`...`],
                tsconfig: `...`,
                ...
            }
        ]
    ]
    ...
}
@tgreyuk
Copy link
Member

tgreyuk commented Jun 12, 2023

Types are exposed in 'next' version. If strongly type checking is required I think something like this would be required:

/** @type {Partial<import("typedoc").TypeDocOptions> & Partial<import("docusaurus-plugin-typedoc").PluginOptions>} */

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Jun 12, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 4, 2024

docusaurus-plugin-typedoc@1.0.0

@tgreyuk tgreyuk closed this as completed May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next Fix available in the '@next' release
Projects
None yet
Development

No branches or pull requests

2 participants