@@ -2,42 +2,122 @@ declare module NativeScriptDoctor {
22 export const doctor : IDoctor ;
33 export const sysInfo : ISysInfo ;
44
5+ /**
6+ * Describes methods which helps collecting system information.
7+ */
58 export interface ISysInfo {
9+ /**
10+ * Returns the currently installed Java version.
11+ * @return {Promise<string> } The currently installed Java version.
12+ */
613 getJavaVersion ( ) : Promise < string > ;
714
15+ /**
16+ * Returns the currently installed Java compiler version.
17+ * @return {Promise<string> } The currently installed Java compiler version.
18+ */
819 getJavaCompilerVersion ( ) : Promise < string > ;
920
10- getXCodeVersion ( ) : Promise < string > ;
21+ /**
22+ * Returns the currently installed version of Xcode.
23+ * @return {Promise<string> } Returns the currently installed version of Xcode or null if Xcode is not installed or executed on Linux or Windows.
24+ */
25+ getXcodeVersion ( ) : Promise < string > ;
1126
27+ /**
28+ * Returns the currently installed Node.js version.
29+ * @return {Promise<string> } Returns the currently installed Node.js version.
30+ */
1231 getNodeVersion ( ) : Promise < string > ;
1332
33+ /**
34+ * Returns the currently installed node-gyp version.
35+ * @return {Promise<string> } Returns the currently installed node-gyp version. If node-gyp is not installed it will return null.
36+ */
1437 getNodeGypVersion ( ) : Promise < string > ;
1538
16- getXCodeProjGemLocation ( ) : Promise < string > ;
39+ /**
40+ * Returns the xcodeproj gem location.
41+ * @return {Promise<string> } Returns the xcodeproj gem location. If the the xcodeproj gem is not installed it will return null.
42+ */
43+ getXcodeprojGemLocation ( ) : Promise < string > ;
1744
45+ /**
46+ * Checks if iTunes is installed.
47+ * @return {Promise<string> } Returns true if iTunes is installed.
48+ */
1849 isITunesInstalled ( ) : Promise < boolean > ;
1950
20- getCocoapodVersion ( ) : Promise < string > ;
51+ /**
52+ * Returns the currently installed Cocoapods version.
53+ * @return {Promise<string> } Returns the currently installed Cocoapods version. It will return null if Cocoapods is not installed.
54+ */
55+ getCocoaPodsVersion ( ) : Promise < string > ;
2156
57+ /**
58+ * Returns the os name.
59+ * @return {Promise<string> } Returns the os name.
60+ */
2261 getOs ( ) : Promise < string > ;
2362
63+ /**
64+ * Returns the currently installed ADB version.
65+ * @return {Promise<string> } Returns the currently installed ADB version. It will return null if ADB is not installed.
66+ */
2467 getAdbVersion ( ) : Promise < string > ;
2568
69+ /**
70+ * Checks if Android is installed.
71+ * @return {Promise<boolean> } Returns true if Android is installed.
72+ */
2673 isAndroidInstalled ( ) : Promise < boolean > ;
2774
75+ /**
76+ * Returns the currently installed Mono version.
77+ * @return {Promise<string> } Returns the currently installed Mono version. It will return null if Mono is not installed.
78+ */
2879 getMonoVersion ( ) : Promise < string > ;
2980
81+ /**
82+ * Returns the currently installed Git version.
83+ * @return {Promise<string> } Returns the currently installed Git version. It will return null if Git is not installed.
84+ */
3085 getGitVersion ( ) : Promise < string > ;
3186
87+ /**
88+ * Returns the currently installed Gradle version.
89+ * @return {Promise<string> } Returns the currently installed Gradle version. It will return null if Gradle is not installed.
90+ */
3291 getGradleVersion ( ) : Promise < string > ;
3392
34- getSysInfo ( ) : Promise < ISysInfoData > ;
93+ /**
94+ * Checks if CocoaPods is working correctly by trying to install one pod.
95+ * @return {Promise<boolean> } Returns true if CocoaPods is working correctly.
96+ */
97+ isCocoaPodsWorkingCorrectly ( ) : Promise < boolean > ;
3598
36- isCocoaPodsWorkingCorrectly ( ) : Promise < boolean >
99+ /**
100+ * Returns the whole system information.
101+ * @return {Promise<ISysInfoData> } The system information.
102+ */
103+ getSysInfo ( ) : Promise < ISysInfoData > ;
37104 }
38105
106+ /**
107+ * Describes methods which help identifying if the environment can be used for development of {N} apps.
108+ */
39109 export interface IDoctor {
110+ /**
111+ * Checks if a local build can be executed on the current machine.
112+ * @param {string } platform The platform for which to check if local build is possible.
113+ * @return {Promise<boolean> } true if local build can be executed for the provided platform.
114+ */
40115 canExecuteLocalBuild ( platform : string ) : Promise < boolean > ;
116+
117+ /**
118+ * Executes all checks for the current environment and returns the warnings from each check.
119+ * @return {Promise<IWarning[]> } Array of all the warnings from all checks. If there are no warnings will return empty array.
120+ */
41121 getWarnings ( ) : Promise < IWarning [ ] > ;
42122 }
43123
@@ -151,7 +231,7 @@ declare module NativeScriptDoctor {
151231 * pod version string, as returned by `pod --version`.
152232 * @type {string }
153233 */
154- cocoapodVer : string ;
234+ cocoaPodsVer : string ;
155235
156236 /**
157237 * xcodeproj gem location, as returned by `which gem xcodeproj`.
0 commit comments