diff --git a/PublicAPI.md b/PublicAPI.md index e29610ab9a..0434108d54 100644 --- a/PublicAPI.md +++ b/PublicAPI.md @@ -3,35 +3,17 @@ Public API This document describes all methods that can be invoked when NativeScript CLI is required as library, i.e. -
- JavaScript - | -- TypeScript - | -
-
+```JavaScript
const tns = require("nativescript");
-
- |
-
-
-import * as tns from "nativescript";
-
- |
-
- JavaScript - | -- TypeScript - | -
-
+* Sample usage:
+```JavaScript
const projectSettings = {
projectName: "my-ns-app",
- template: "ng",
- pathToProject: "/home/my-user/project-dir"
+ template: "ng",
+ pathToProject: "/home/my-user/project-dir"
};
tns.projectService.createProject(projectSettings)
.then(() => console.log("Project successfully created."))
- .catch((err) => console.log("Unable to create project, reason: ", err);
-
- |
-
-
-const projectSettings: IProjectSettings = {
- projectName: "my-ns-app",
- template: "ng",
- pathToProject: "/home/my-user/project-dir"
-};
+ .catch((err) => console.log("Unable to create project, reason: ", err);
+```
-tns.projectService.createProject(projectSettings)
- .then(() => console.log("Project successfully created."))
- .catch((err) => console.log("Unable to create project, reason: ", err);
-
- |
-
- JavaScript - | -- TypeScript - | -
-
-const isValidProject = tns.projectService.isValidNativeScriptProject("/tmp/myProject");
-
- |
-
-
+### isValidNativeScriptProject
+* Definition: `isValidNativeScriptProject(projectDir: string): boolean` - Checks if the specified path is a valid NativeScript project. Returns `true` in case the directory is a valid project, `false` otherwise.
+
+* Sample usage:
+```JavaScript
const isValidProject = tns.projectService.isValidNativeScriptProject("/tmp/myProject");
-
- |
-