Skip to content

Commit 7e01834

Browse files
Merge pull request #312 from dixyushi/update-doc-buildNg
updated function buildNg
2 parents 7d9ec58 + 3ea0b36 commit 7e01834

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

documentation/Functions.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -497,15 +497,33 @@ Note: The command for execution will be generated by Katacoda runner, so user wi
497497
***
498498

499499
### buildNg <a name="buildNg"></a>
500+
This function is used to build Angular project.
501+
500502
#### parameter
501-
1. Path to the angular project, relative to workspace
502-
2. (Optional) Custom output directory.
503+
This function consist of two parameter.
504+
505+
1. First parameter:
506+
- **Required**
507+
- **Type**- String
508+
- **Description**-It is the path to the Angular project, relative to workspace.
509+
510+
2. Second parameter:
511+
- **optional**
512+
- **Type**- String
513+
- **Description**- It is the custom output directory.
503514
#### example
504-
buildNg("exampleAngularProject")
505-
Will build the angular project to default output directory defined in angular.json outputPath key, normally set to dist/.
515+
* buildNg("exampleAngularProject")
516+
Will build the Angular project to default output directory defined in angular.json outputPath key, normally set to dist/.
517+
518+
* buildNg("exampleAngularProject", "testOutput")
519+
Will build the Angular project to output directory testOutput.
520+
521+
Note:
522+
1. To use only one parameter, you should have Angular CLI installed and the folder should exist. This can be done by using the devonfw-ide or by installing it manually with the npmInstall function.
523+
524+
2. The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
506525

507-
buildNg("exampleAngularProject", "testOutput")
508-
Will build the angular project to output directory testOutput.
526+
3. No background script will run.
509527

510528
***
511529

0 commit comments

Comments
 (0)