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

Unable to use options.json/tsconfig.json programatically #1162

Closed
Gerrit0 opened this issue Jan 12, 2020 · 1 comment
Closed

Unable to use options.json/tsconfig.json programatically #1162

Gerrit0 opened this issue Jan 12, 2020 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 12, 2020

Expected Behavior

The following code from the website should work:

const TypeDoc = require('typedoc');

const app = new TypeDoc.Application({
    mode:   'Modules',
    logger: 'none',
    target: 'ES5',
    module: 'CommonJS',
    experimentalDecorators: true
});
app.options.addReader(new TypeDoc.TypeDocReader());
app.options.addReader(new TypeDoc.TSConfigReader());
app.bootstrap();

const project = app.convert(app.expandInputFiles(['src']));

if (project) { // Project may not have converted correctly
    const outputDir = 'docs';

    // Rendered docs
    app.generateDocs(project, outputDir);
    // Alternatively generate JSON output
    app.generateJson(project, outputDir + '/documentation.json');
}

Actual Behavior

Crash - TypeDocReader and TSConfigReader are not exported

Environment

  • Typedoc version: v0.16.0
  • Node.js version: N/A
  • OS: N/A
@Gerrit0 Gerrit0 added the bug Functionality does not match expectation label Jan 12, 2020
@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Jan 12, 2020

Of course I found this only after publishing :/

Fixed in 0.16.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant