aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/typescript-module.qdoc
blob: 4c65c227974de2cdb5a3037ce7d3724b725b84f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \contentspage index.html
    \qmltype typescript
    \inqmlmodule QbsModules
    \since Qbs 1.3

    \brief Provides TypeScript support.

    The \c typescript module contains properties and rules for building
    \l{TypeScript} applications and may be used in combination with the
    \l{nodejs} module to run the applications directly from \QBS.
*/

/*!
    \qmlproperty string typescript::warningLevel

    The severity of warnings to emit. The higher the level, the more warnings
    will be shown.

    \c{pedantic} causes the TypeScript to emit warnings on expressions and
    declarations with an implied \e any type.

    \defaultvalue \c{"normal"}
*/

/*!
    \qmlproperty string typescript::targetVersion

    The ECMAScript target version for generated JavaScript code.

    If left undefined, the TypeScript \l{Compiler Options}{compiler default} is
    used.

    \nodefaultvalue
*/

/*!
    \qmlproperty string typescript::moduleLoader

    If TypeScript modules are being used, the JavaScript module loading
    mechanism to use in the generated JavaScript code.

    If left undefined, modules are not used.

    See \l{Compiler Options} for a list of possible values.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool typescript::stripComments

    Whether to remove comments from the generated JavaScript files.

    \defaultvalue \l{qbs::debugInformation}{!qbs.debugInformation}
*/

/*!
    \qmlproperty bool typescript::generateDeclarations

    Whether to generate the corresponding \c .d.ts files during compilation.
    These are TypeScript's equivalent of header files.

    \defaultvalue \c{false}
*/

/*!
    \qmlproperty bool typescript::generateSourceMaps

    Whether to generate the corresponding \c .map files during compilation.

    \defaultvalue \l{qbs::debugInformation}{qbs.debugInformation}
*/

/*!
    \qmlproperty stringList typescript::compilerFlags

    A list of additional flags for the TypeScript compiler.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool typescript::singleFile

    Whether to compile all TypeScript source files to a single JavaScript output
    file.

    The default is to compile each TypeScript file to a corresponding JavaScript
    file. This property is incompatible with \l{typescript}{moduleLoader}.

    \defaultvalue \c{false}
*/

/*!
    \qmlproperty string typescript::version

    The TypeScript version.

    Consists of four numbers separated by dots. For example, "1.0.0.0".

    \nodefaultvalue
*/

/*!
    \qmlproperty int typescript::versionMajor

    The TypeScript major version.

    \defaultvalue \c{versionParts[0]}
*/

/*!
    \qmlproperty int typescript::versionMinor

    The TypeScript minor version.

    \defaultvalue \c{versionParts[1]}
*/

/*!
    \qmlproperty list typescript::versionParts

    The TypeScript version as a list.

    For example, TypeScript version 1.0 would correspond to a value of
    \c[1, 0, 0, 0].

    \defaultvalue \c []
*/

/*!
    \qmlproperty int typescript::versionPatch

    The TypeScript patch level.

    \defaultvalue \c{versionParts[2]}
*/

/*!
    \qmlproperty int typescript::versionBuild

    The fourth TypeScript version number component.

    \defaultvalue \c{versionParts[3]}
*/

/*!
    \qmlproperty path typescript::toolchainInstallPath

    The TypeScript installation directory.

    This property should not normally need to be changed if \c{tsc} is available
    by searching the PATH environment variable.

    \nodefaultvalue
*/

/*!
    \qmlproperty string typescript::compilerName

    The name of the compiler binary.

    This property should not normally need to be changed.

    \defaultvalue \c{"tsc"}
*/

/*!
    \qmlproperty string typescript::compilerPath

    The directory where the compiler binary is located.

    This property should not normally need to be changed.

    \defaultvalue \c{compilerName}
*/