TypeDoc is having trouble locating the Angular 2 modules

Currently, I am attempting to create documentation files using TypeDoc. When executing TypeDoc with the command below:

/node_modules/.bin/typedoc --module system --target ES5 --exclude *.spec.ts* --experimentalDecorators --out typedoc app/ --ignoreCompilerErrors

The following output is produced:

Using TypeScript 1.6.2 from /development/node_modules/typedoc/node_modules/typescript/lib
Error: /development/app/angular2/app.ts(1)
 Cannot find module 'angular2/core'.
Error: /development/app/angular2/app.ts(2)
 Cannot find module 'angular2/upgrade'.
Error: /development/app/angular2/app.ts(3)
 Cannot find module 'angular2/platform/browser'.
Error: /development/app/angular2/app.ts(5)

tsconfig.json

{
  "compilerOptions": {
    "target": "ES5",
    "module": "system",
    "moduleResolution": "node",
    "sourceMap": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "removeComments": false,
    "noImplicitAny": false
  },
  "exclude": [
    "node_modules"
  ]
}

I am questioning whether there might be a parameter that I missed in order to include the libraries or .d.ts. files?

angulartypescripttypedoc

Answer №1

My attempt with the commonjs module was successful.

typedoc --experimentalDecorators --target 'es5' --module 'commonjs' --out doc-destination/ src/

Answer №2

In my angular2 application, I utilize typedoc along with gulp-typedoc to generate documentation. The parameters passed to gulp-typedoc remain consistent throughout the process. Here is the gulp task that successfully handles this for me:

gulp.task("doc", function() {
    return gulp
        .src(["./myproject/**/*.ts"])
        .pipe(typedoc({ 
            // TypeScript options (see typescript docs) 
            module: "commonjs", 
            target: "es5",
            includeDeclarations: false,
            experimentalDecorators: true,

            // Output options (see typedoc docs) 
            out: "./docs", 

            // TypeDoc options (see typedoc docs) 
            name: "MyProject", 
            ignoreCompilerErrors: false,
            excludeExternals:true,
            version: true,
        }));
});

I trust this information proves helpful.

Answer №3

Include the settings for type definition files in your tsconfig.json file and give it a go

"typeRoots": [
  "node_modules/@types" ]

Similar questions

If you have not found the answer to your question or you are interested in this topic, then look at other similar questions below or use the search

Only JSON objects with a boolean value of true will be returned

I am working on returning JSON objects in JavaScript/TypeScript that have a true boolean value for the "team" property. For example, the JSON data I am using is as follows: { "state": "Texas", "stateId": 1, "team": true }, { "state": "Cali ...

javascriptarraysjsontypescriptboolean

Using Angular Project: Exploring the Feasibility of Accessing SCSS Files from Node_modules in Custom Components

When setting up Angular, how can I include a Bootstrap SCSS file in a Custom Component using Style.SCSS? In Angular.json { "$schema": "./node_modules/@angular/cli/lib/config/schema.json", "version": 1, "newProjectRoot": "projects", "p ...

angulartwitter-bootstrapwebpacksass

Can you identify the category of the new Set containing the elements 1, 2, and 3?

As a beginner in TypeScript, I'm currently exploring the appropriate type for JavaScript's new Set([1, 2, 3]), but my search has been unsuccessful so far. For instance: const objNums: {[key: string]: number} = {one: 1, two: 2, three: 3}; const a ...

typescript

Using TypeScript with React: Automatically infer the prop type from a generic parameter

I've developed a component that retrieves data from an API and presents it in a table. There's a prop that enables the fetched value to be displayed differently within the table. Here's how I currently have the prop types set up: // T repres ...

reactjstypescript

Best approach for managing Union Types in Angular 16 Templates / Utilizing Type Inference?

Currently, I'm immersed in a project using Angular 16 where my focus lies on applying a reactive declarative method. Oftentimes, I find myself working with Observables that emit varying data types - either successful data or an error object. Each ret ...

angulartypescriptrxjscastingtypeerror

The condition will be false if a number is present, even if it is zero

I am facing an issue with a class containing an optional field called startDateHour: export class Test { startDateHour?: number; // more fields, constructor etc. } I need to perform an action only if the startDateHour exists: if (test.startDateHour ...

angulartypescript

The input text in the Typeahead field does not reset even after calling this.setState

As I work on creating a watchlist with typeahead functionality to suggest options as the user types, I encountered an issue where the text box is not resetting after submission. I attempted the solution mentioned in this resource by calling this.setState( ...

javascriptreactjstypescriptstate

I am looking to customize the mask input in my angular 7 application so that it allows either a "-" or a digit as the first character, with all subsequent characters being digits. How can I make this modification?

Within my Angular 7 application, I am working on a method that masks user input. Currently, the method restricts users from inputting anything other than digits. However, I need to modify it so that users can input either a "-" or a digit as the first char ...

regexangularangular7masking

Encountering issues with MatTable functionality in Angular version 10

Could it be that I’m starting this project from scratch using Angular Material 10, a framework I’m not familiar with yet, or am I simply missing something? My mat-table isn’t showing up on the page at all, which is completely new to me. Here’s the ...

angularangular-materialangular-material-table

What is the best way to access and read all @input elements within an Angular component?

Looking to retrieve all properties marked with the @Input() decorator in an Angular component. Attempts using reflect and reflect-metadata have been unsuccessful. Any suggestions on how to achieve this functionality? ...

angulardecorator

What is the process for generating a fresh instance of an Angular service?

Hey there, I've been pondering a solution to a little dilemma I'm facing. Let me share my thoughts and see if you can lend some insight or tell me where I might be going astray. Setting the Stage: In the realm of angular app creation, it's ...

javascriptangular

Angular 2: Executing a function after ngFor has completed

Within Angular 1, I crafted a personalized directive called "repeater-ready" to pair with ng-repeat for triggering a callback method upon completion of an iteration: if ($scope.$last === true) { $timeout(() => { $scope.$parent.$parent.$ ...

javascriptangularjsangularngfor

Is it necessary for TrackBy to be a function in Angular 2, or can it be undefined?

Struggling with an error while developing a demo app in Angular 2. The error message reads: core.umd.js:3491 EXCEPTION: Uncaught (in promise): Error: Error in security.component.html:35:72 caused by: trackBy must be a function, but received undefined. Err ...

angulartypescript

The div element is finally loading properly after multiple clicks

I need some assistance with loading dynamic divs in Angular. I have created a button that adds new divs each time it is clicked in a specific area. However, once these new divs are added, they appear incorrectly: After adding the divs, the editor and cale ...

javascripthtmlangulartypescriptprimeng

Understanding how the context of an Angular2 component interacts within a jQuery timepicker method

Scenario: I am developing a time picker component for Angular 2. I need to pass values from Angular 2 Components to the jQuery timepicker in order to set parameters like minTime and maxTime. Below is the code snippet: export class TimePicker{ @Input() ...

javascriptjqueryangulartypescript

Issue with Angular CLI build test: Unable to locate ng2-material

Currently, I am in the process of developing a new Angular 2 application with the Alpha version of Angular-CLI. To enhance its functionality, I have decided to incorporate the ng2-material library. However, in order to make it work effectively, I had to ex ...

angularjsangularkarma-runnerkarma-jasmineangular-cli

What specific characteristic of TypeScript's number data type or the Math.ceil() function is responsible for this calculation mistake?

Currently, I am working on a function in Typescript that is supposed to generate a unique number each time it runs. However, there seems to be a problem with the arithmetic as the results are not always correct. Upon further examination of the code below, ...

javascripttypescriptmath

Creating a Typescript HttpInterceptor and ensuring its compatibility with minification techniques

Currently, I am trying to implement an Angular HttpInterceptor based on the solution provided in this Stack Overflow response: However, I am struggling with the factory method: public static Factory($q: ng.IQService) { return new AuthenticationInter ...

angularjstypescript

Utilizing a single resolver for both parent and child routes in Angular 2

In my Angular 2.0 (stable version) application, I have a specific entity called project. The details of each project are spread across different sections/routes within the app: project/:id/overview project/:id/documents project/:id/logs and more The API ...

angularangular2-routing

The status of the S3 file upload using a presigned URL is showing as (cancelled)

I'm currently facing an issue with uploading a file to Amazon S3 using the Angular client. I have successfully generated a Presigned URL using a NodeJs application server. However, when attempting to upload the file to the presigned URL, the upload fa ...

angularamazon-web-servicesamazon-s3clientpre-signed-url