5.4/javascript/typescript/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>TypeScript - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#typescript" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               TypeScript
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 676
 677
 678         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
 679
 680       <label class="md-nav__link" for="__nav_4">
 681         TypeScript and JavaScript API
 682         <span class="md-nav__icon md-icon"></span>
 683       </label>
 684       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 685         <label class="md-nav__title" for="__nav_4">
 686           <span class="md-nav__icon md-icon"></span>
 687           TypeScript and JavaScript API
 688         </label>
 689         <ul class="md-nav__list" data-md-scrollfix>
 690
 691
 692
 693
 694
 695     <li class="md-nav__item">
 696       <a href="../general-usage/" class="md-nav__link">
 697         General Usage
 698       </a>
 699     </li>
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709     <li class="md-nav__item md-nav__item--active">
 710
 711       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 712
 713
 714
 715
 716         <label class="md-nav__link md-nav__link--active" for="__toc">
 717           TypeScript
 718           <span class="md-nav__icon md-icon"></span>
 719         </label>
 720
 721       <a href="./" class="md-nav__link md-nav__link--active">
 722         TypeScript
 723       </a>
 724
 725
 726 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 727
 728
 729
 730
 731
 732     <label class="md-nav__title" for="__toc">
 733       <span class="md-nav__icon md-icon"></span>
 734       Table of contents
 735     </label>
 736     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 737
 738         <li class="md-nav__item">
 739   <a href="#consuming-woltlab-suites-types" class="md-nav__link">
 740     Consuming WoltLab Suite’s Types
 741   </a>
 742
 743 </li>
 744
 745         <li class="md-nav__item">
 746   <a href="#additional-tools" class="md-nav__link">
 747     Additional Tools
 748   </a>
 749
 750     <nav class="md-nav" aria-label="Additional Tools">
 751       <ul class="md-nav__list">
 752
 753           <li class="md-nav__item">
 754   <a href="#prettierrc" class="md-nav__link">
 755     .prettierrc
 756   </a>
 757
 758 </li>
 759
 760           <li class="md-nav__item">
 761   <a href="#eslintrcjs" class="md-nav__link">
 762     .eslintrc.js
 763   </a>
 764
 765 </li>
 766
 767           <li class="md-nav__item">
 768   <a href="#eslintignore" class="md-nav__link">
 769     .eslintignore
 770   </a>
 771
 772 </li>
 773
 774           <li class="md-nav__item">
 775   <a href="#gitattributes" class="md-nav__link">
 776     .gitattributes
 777   </a>
 778
 779 </li>
 780
 781       </ul>
 782     </nav>
 783
 784 </li>
 785
 786         <li class="md-nav__item">
 787   <a href="#writing-a-simple-module" class="md-nav__link">
 788     Writing a simple module
 789   </a>
 790
 791 </li>
 792
 793     </ul>
 794
 795 </nav>
 796
 797     </li>
 798
 799
 800
 801
 802
 803
 804
 805
 806     <li class="md-nav__item md-nav__item--nested">
 807
 808
 809         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 810
 811       <label class="md-nav__link" for="__nav_4_3">
 812         New API
 813         <span class="md-nav__icon md-icon"></span>
 814       </label>
 815       <nav class="md-nav" aria-label="New API" data-md-level="2">
 816         <label class="md-nav__title" for="__nav_4_3">
 817           <span class="md-nav__icon md-icon"></span>
 818           New API
 819         </label>
 820         <ul class="md-nav__list" data-md-scrollfix>
 821
 822
 823
 824
 825
 826     <li class="md-nav__item">
 827       <a href="../new-api_writing-a-module/" class="md-nav__link">
 828         Writing a module
 829       </a>
 830     </li>
 831
 832
 833
 834
 835
 836
 837
 838     <li class="md-nav__item">
 839       <a href="../new-api_data-structures/" class="md-nav__link">
 840         Data Structures
 841       </a>
 842     </li>
 843
 844
 845
 846
 847
 848
 849
 850     <li class="md-nav__item">
 851       <a href="../new-api_core/" class="md-nav__link">
 852         Core Functions
 853       </a>
 854     </li>
 855
 856
 857
 858
 859
 860
 861
 862     <li class="md-nav__item">
 863       <a href="../new-api_dom/" class="md-nav__link">
 864         DOM
 865       </a>
 866     </li>
 867
 868
 869
 870
 871
 872
 873
 874     <li class="md-nav__item">
 875       <a href="../new-api_events/" class="md-nav__link">
 876         Event Handling
 877       </a>
 878     </li>
 879
 880
 881
 882
 883
 884
 885
 886     <li class="md-nav__item">
 887       <a href="../new-api_ajax/" class="md-nav__link">
 888         Ajax
 889       </a>
 890     </li>
 891
 892
 893
 894
 895
 896
 897
 898     <li class="md-nav__item">
 899       <a href="../new-api_dialogs/" class="md-nav__link">
 900         Dialogs
 901       </a>
 902     </li>
 903
 904
 905
 906
 907
 908
 909
 910     <li class="md-nav__item">
 911       <a href="../new-api_browser/" class="md-nav__link">
 912         Browser and Screen Sizes
 913       </a>
 914     </li>
 915
 916
 917
 918
 919
 920
 921
 922     <li class="md-nav__item">
 923       <a href="../new-api_ui/" class="md-nav__link">
 924         User Interface
 925       </a>
 926     </li>
 927
 928
 929
 930         </ul>
 931       </nav>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="../legacy-api/" class="md-nav__link">
 942         Legacy API
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../helper-functions/" class="md-nav__link">
 954         Helper Functions
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../code-snippets/" class="md-nav__link">
 966         Code Snippets
 967       </a>
 968     </li>
 969
 970
 971
 972         </ul>
 973       </nav>
 974     </li>
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986     <li class="md-nav__item md-nav__item--nested">
 987
 988
 989         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 990
 991       <label class="md-nav__link" for="__nav_5">
 992         Package Components
 993         <span class="md-nav__icon md-icon"></span>
 994       </label>
 995       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 996         <label class="md-nav__title" for="__nav_5">
 997           <span class="md-nav__icon md-icon"></span>
 998           Package Components
 999         </label>
1000         <ul class="md-nav__list" data-md-scrollfix>
1001
1002
1003
1004
1005
1006     <li class="md-nav__item">
1007       <a href="../../package/package-xml/" class="md-nav__link">
1008         package.xml
1009       </a>
1010     </li>
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item md-nav__item--nested">
1020
1021
1022         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1023
1024       <label class="md-nav__link" for="__nav_5_2">
1025         PIPs
1026         <span class="md-nav__icon md-icon"></span>
1027       </label>
1028       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1029         <label class="md-nav__title" for="__nav_5_2">
1030           <span class="md-nav__icon md-icon"></span>
1031           PIPs
1032         </label>
1033         <ul class="md-nav__list" data-md-scrollfix>
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../../package/pip/" class="md-nav__link">
1041         Overview
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../../package/pip/acl-option/" class="md-nav__link">
1053         aclOption
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1065         acpMenu
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1077         acpSearchProvider
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../../package/pip/acp-template/" class="md-nav__link">
1089         acpTemplate
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../../package/pip/bbcode/" class="md-nav__link">
1101         bbcode
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../../package/pip/box/" class="md-nav__link">
1113         box
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1125         clipboardAction
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../../package/pip/core-object/" class="md-nav__link">
1137         coreObject
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../../package/pip/cronjob/" class="md-nav__link">
1149         cronjob
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../../package/pip/database/" class="md-nav__link">
1161         database
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../../package/pip/event-listener/" class="md-nav__link">
1173         eventListener
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../../package/pip/file/" class="md-nav__link">
1185         file
1186       </a>
1187     </li>
1188
1189
1190
1191
1192
1193
1194
1195     <li class="md-nav__item">
1196       <a href="../../package/pip/language/" class="md-nav__link">
1197         language
1198       </a>
1199     </li>
1200
1201
1202
1203
1204
1205
1206
1207     <li class="md-nav__item">
1208       <a href="../../package/pip/media-provider/" class="md-nav__link">
1209         mediaProvider
1210       </a>
1211     </li>
1212
1213
1214
1215
1216
1217
1218
1219     <li class="md-nav__item">
1220       <a href="../../package/pip/menu/" class="md-nav__link">
1221         menu
1222       </a>
1223     </li>
1224
1225
1226
1227
1228
1229
1230
1231     <li class="md-nav__item">
1232       <a href="../../package/pip/menu-item/" class="md-nav__link">
1233         menuItem
1234       </a>
1235     </li>
1236
1237
1238
1239
1240
1241
1242
1243     <li class="md-nav__item">
1244       <a href="../../package/pip/object-type/" class="md-nav__link">
1245         objectType
1246       </a>
1247     </li>
1248
1249
1250
1251
1252
1253
1254
1255     <li class="md-nav__item">
1256       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1257         objectTypeDefinition
1258       </a>
1259     </li>
1260
1261
1262
1263
1264
1265
1266
1267     <li class="md-nav__item">
1268       <a href="../../package/pip/option/" class="md-nav__link">
1269         option
1270       </a>
1271     </li>
1272
1273
1274
1275
1276
1277
1278
1279     <li class="md-nav__item">
1280       <a href="../../package/pip/page/" class="md-nav__link">
1281         page
1282       </a>
1283     </li>
1284
1285
1286
1287
1288
1289
1290
1291     <li class="md-nav__item">
1292       <a href="../../package/pip/pip/" class="md-nav__link">
1293         pip
1294       </a>
1295     </li>
1296
1297
1298
1299
1300
1301
1302
1303     <li class="md-nav__item">
1304       <a href="../../package/pip/script/" class="md-nav__link">
1305         script
1306       </a>
1307     </li>
1308
1309
1310
1311
1312
1313
1314
1315     <li class="md-nav__item">
1316       <a href="../../package/pip/smiley/" class="md-nav__link">
1317         smiley
1318       </a>
1319     </li>
1320
1321
1322
1323
1324
1325
1326
1327     <li class="md-nav__item">
1328       <a href="../../package/pip/sql/" class="md-nav__link">
1329         sql
1330       </a>
1331     </li>
1332
1333
1334
1335
1336
1337
1338
1339     <li class="md-nav__item">
1340       <a href="../../package/pip/style/" class="md-nav__link">
1341         style
1342       </a>
1343     </li>
1344
1345
1346
1347
1348
1349
1350
1351     <li class="md-nav__item">
1352       <a href="../../package/pip/template/" class="md-nav__link">
1353         template
1354       </a>
1355     </li>
1356
1357
1358
1359
1360
1361
1362
1363     <li class="md-nav__item">
1364       <a href="../../package/pip/template-listener/" class="md-nav__link">
1365         templateListener
1366       </a>
1367     </li>
1368
1369
1370
1371
1372
1373
1374
1375     <li class="md-nav__item">
1376       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1377         userGroupOption
1378       </a>
1379     </li>
1380
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../../package/pip/user-menu/" class="md-nav__link">
1389         userMenu
1390       </a>
1391     </li>
1392
1393
1394
1395
1396
1397
1398
1399     <li class="md-nav__item">
1400       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1401         userNotificationEvent
1402       </a>
1403     </li>
1404
1405
1406
1407
1408
1409
1410
1411     <li class="md-nav__item">
1412       <a href="../../package/pip/user-option/" class="md-nav__link">
1413         userOption
1414       </a>
1415     </li>
1416
1417
1418
1419
1420
1421
1422
1423     <li class="md-nav__item">
1424       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1425         userProfileMenu
1426       </a>
1427     </li>
1428
1429
1430
1431         </ul>
1432       </nav>
1433     </li>
1434
1435
1436
1437
1438
1439
1440
1441     <li class="md-nav__item">
1442       <a href="../../package/database-php-api/" class="md-nav__link">
1443         Database PHP API
1444       </a>
1445     </li>
1446
1447
1448
1449         </ul>
1450       </nav>
1451     </li>
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463     <li class="md-nav__item md-nav__item--nested">
1464
1465
1466         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1467
1468       <label class="md-nav__link" for="__nav_6">
1469         Migration
1470         <span class="md-nav__icon md-icon"></span>
1471       </label>
1472       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1473         <label class="md-nav__title" for="__nav_6">
1474           <span class="md-nav__icon md-icon"></span>
1475           Migration
1476         </label>
1477         <ul class="md-nav__list" data-md-scrollfix>
1478
1479
1480
1481
1482
1483
1484     <li class="md-nav__item md-nav__item--nested">
1485
1486
1487         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1488
1489       <label class="md-nav__link" for="__nav_6_1">
1490         Migrating from WSC 5.3
1491         <span class="md-nav__icon md-icon"></span>
1492       </label>
1493       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1494         <label class="md-nav__title" for="__nav_6_1">
1495           <span class="md-nav__icon md-icon"></span>
1496           Migrating from WSC 5.3
1497         </label>
1498         <ul class="md-nav__list" data-md-scrollfix>
1499
1500
1501
1502
1503
1504     <li class="md-nav__item">
1505       <a href="../../migration/wsc53/php/" class="md-nav__link">
1506         PHP API
1507       </a>
1508     </li>
1509
1510
1511
1512
1513
1514
1515
1516     <li class="md-nav__item">
1517       <a href="../../migration/wsc53/session/" class="md-nav__link">
1518         Session Handling and Authentication
1519       </a>
1520     </li>
1521
1522
1523
1524
1525
1526
1527
1528     <li class="md-nav__item">
1529       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1530         TypeScript and JavaScript
1531       </a>
1532     </li>
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1542         Templates
1543       </a>
1544     </li>
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1554         Third Party Libraries
1555       </a>
1556     </li>
1557
1558
1559
1560         </ul>
1561       </nav>
1562     </li>
1563
1564
1565
1566
1567
1568
1569
1570
1571     <li class="md-nav__item md-nav__item--nested">
1572
1573
1574         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1575
1576       <label class="md-nav__link" for="__nav_6_2">
1577         Migrating from WSC 5.2
1578         <span class="md-nav__icon md-icon"></span>
1579       </label>
1580       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1581         <label class="md-nav__title" for="__nav_6_2">
1582           <span class="md-nav__icon md-icon"></span>
1583           Migrating from WSC 5.2
1584         </label>
1585         <ul class="md-nav__list" data-md-scrollfix>
1586
1587
1588
1589
1590
1591     <li class="md-nav__item">
1592       <a href="../../migration/wsc52/php/" class="md-nav__link">
1593         PHP API
1594       </a>
1595     </li>
1596
1597
1598
1599
1600
1601
1602
1603     <li class="md-nav__item">
1604       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1605         Templates and Languages
1606       </a>
1607     </li>
1608
1609
1610
1611
1612
1613
1614
1615     <li class="md-nav__item">
1616       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1617         Third Party Libraries
1618       </a>
1619     </li>
1620
1621
1622
1623         </ul>
1624       </nav>
1625     </li>
1626
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item md-nav__item--nested">
1635
1636
1637         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1638
1639       <label class="md-nav__link" for="__nav_6_3">
1640         Migrating from WSC 3.1
1641         <span class="md-nav__icon md-icon"></span>
1642       </label>
1643       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1644         <label class="md-nav__title" for="__nav_6_3">
1645           <span class="md-nav__icon md-icon"></span>
1646           Migrating from WSC 3.1
1647         </label>
1648         <ul class="md-nav__list" data-md-scrollfix>
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../migration/wsc31/php/" class="md-nav__link">
1656         PHP API
1657       </a>
1658     </li>
1659
1660
1661
1662         </ul>
1663       </nav>
1664     </li>
1665
1666
1667
1668
1669
1670
1671
1672
1673     <li class="md-nav__item md-nav__item--nested">
1674
1675
1676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1677
1678       <label class="md-nav__link" for="__nav_6_4">
1679         Migrating from WSC 3.0
1680         <span class="md-nav__icon md-icon"></span>
1681       </label>
1682       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1683         <label class="md-nav__title" for="__nav_6_4">
1684           <span class="md-nav__icon md-icon"></span>
1685           Migrating from WSC 3.0
1686         </label>
1687         <ul class="md-nav__list" data-md-scrollfix>
1688
1689
1690
1691
1692
1693     <li class="md-nav__item">
1694       <a href="../../migration/wsc30/php/" class="md-nav__link">
1695         PHP API
1696       </a>
1697     </li>
1698
1699
1700
1701
1702
1703
1704
1705     <li class="md-nav__item">
1706       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1707         JavaScript API
1708       </a>
1709     </li>
1710
1711
1712
1713
1714
1715
1716
1717     <li class="md-nav__item">
1718       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1719         Templates
1720       </a>
1721     </li>
1722
1723
1724
1725
1726
1727
1728
1729     <li class="md-nav__item">
1730       <a href="../../migration/wsc30/css/" class="md-nav__link">
1731         CSS
1732       </a>
1733     </li>
1734
1735
1736
1737
1738
1739
1740
1741     <li class="md-nav__item">
1742       <a href="../../migration/wsc30/package/" class="md-nav__link">
1743         Package Components
1744       </a>
1745     </li>
1746
1747
1748
1749         </ul>
1750       </nav>
1751     </li>
1752
1753
1754
1755
1756
1757
1758
1759
1760     <li class="md-nav__item md-nav__item--nested">
1761
1762
1763         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1764
1765       <label class="md-nav__link" for="__nav_6_5">
1766         Migrating from WCF 2.1
1767         <span class="md-nav__icon md-icon"></span>
1768       </label>
1769       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1770         <label class="md-nav__title" for="__nav_6_5">
1771           <span class="md-nav__icon md-icon"></span>
1772           Migrating from WCF 2.1
1773         </label>
1774         <ul class="md-nav__list" data-md-scrollfix>
1775
1776
1777
1778
1779
1780     <li class="md-nav__item">
1781       <a href="../../migration/wcf21/php/" class="md-nav__link">
1782         PHP API
1783       </a>
1784     </li>
1785
1786
1787
1788
1789
1790
1791
1792     <li class="md-nav__item">
1793       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1794         Templates
1795       </a>
1796     </li>
1797
1798
1799
1800
1801
1802
1803
1804     <li class="md-nav__item">
1805       <a href="../../migration/wcf21/css/" class="md-nav__link">
1806         CSS
1807       </a>
1808     </li>
1809
1810
1811
1812
1813
1814
1815
1816     <li class="md-nav__item">
1817       <a href="../../migration/wcf21/package/" class="md-nav__link">
1818         Package Components
1819       </a>
1820     </li>
1821
1822
1823
1824         </ul>
1825       </nav>
1826     </li>
1827
1828
1829
1830         </ul>
1831       </nav>
1832     </li>
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844     <li class="md-nav__item md-nav__item--nested">
1845
1846
1847         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1848
1849       <label class="md-nav__link" for="__nav_7">
1850         Tutorials
1851         <span class="md-nav__icon md-icon"></span>
1852       </label>
1853       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1854         <label class="md-nav__title" for="__nav_7">
1855           <span class="md-nav__icon md-icon"></span>
1856           Tutorials
1857         </label>
1858         <ul class="md-nav__list" data-md-scrollfix>
1859
1860
1861
1862
1863
1864
1865     <li class="md-nav__item md-nav__item--nested">
1866
1867
1868         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1869
1870       <label class="md-nav__link" for="__nav_7_1">
1871         Tutorial Series
1872         <span class="md-nav__icon md-icon"></span>
1873       </label>
1874       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1875         <label class="md-nav__title" for="__nav_7_1">
1876           <span class="md-nav__icon md-icon"></span>
1877           Tutorial Series
1878         </label>
1879         <ul class="md-nav__list" data-md-scrollfix>
1880
1881
1882
1883
1884
1885     <li class="md-nav__item">
1886       <a href="../../tutorial/series/overview/" class="md-nav__link">
1887         Overview
1888       </a>
1889     </li>
1890
1891
1892
1893
1894
1895
1896
1897     <li class="md-nav__item">
1898       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1899         Part 1
1900       </a>
1901     </li>
1902
1903
1904
1905
1906
1907
1908
1909     <li class="md-nav__item">
1910       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1911         Part 2
1912       </a>
1913     </li>
1914
1915
1916
1917
1918
1919
1920
1921     <li class="md-nav__item">
1922       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1923         Part 3
1924       </a>
1925     </li>
1926
1927
1928
1929         </ul>
1930       </nav>
1931     </li>
1932
1933
1934
1935         </ul>
1936       </nav>
1937     </li>
1938
1939
1940
1941   </ul>
1942 </nav>
1943                   </div>
1944                 </div>
1945               </div>
1946
1947
1948
1949               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1950                 <div class="md-sidebar__scrollwrap">
1951                   <div class="md-sidebar__inner">
1952
1953 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1954
1955
1956
1957
1958
1959     <label class="md-nav__title" for="__toc">
1960       <span class="md-nav__icon md-icon"></span>
1961       Table of contents
1962     </label>
1963     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1964
1965         <li class="md-nav__item">
1966   <a href="#consuming-woltlab-suites-types" class="md-nav__link">
1967     Consuming WoltLab Suite’s Types
1968   </a>
1969
1970 </li>
1971
1972         <li class="md-nav__item">
1973   <a href="#additional-tools" class="md-nav__link">
1974     Additional Tools
1975   </a>
1976
1977     <nav class="md-nav" aria-label="Additional Tools">
1978       <ul class="md-nav__list">
1979
1980           <li class="md-nav__item">
1981   <a href="#prettierrc" class="md-nav__link">
1982     .prettierrc
1983   </a>
1984
1985 </li>
1986
1987           <li class="md-nav__item">
1988   <a href="#eslintrcjs" class="md-nav__link">
1989     .eslintrc.js
1990   </a>
1991
1992 </li>
1993
1994           <li class="md-nav__item">
1995   <a href="#eslintignore" class="md-nav__link">
1996     .eslintignore
1997   </a>
1998
1999 </li>
2000
2001           <li class="md-nav__item">
2002   <a href="#gitattributes" class="md-nav__link">
2003     .gitattributes
2004   </a>
2005
2006 </li>
2007
2008       </ul>
2009     </nav>
2010
2011 </li>
2012
2013         <li class="md-nav__item">
2014   <a href="#writing-a-simple-module" class="md-nav__link">
2015     Writing a simple module
2016   </a>
2017
2018 </li>
2019
2020     </ul>
2021
2022 </nav>
2023                   </div>
2024                 </div>
2025               </div>
2026
2027
2028           <div class="md-content" data-md-component="content">
2029             <article class="md-content__inner md-typeset">
2030
2031
2032                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/typescript.md" title="Edit this page" class="md-content__button md-icon">
2033                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2034                   </a>
2035
2036
2037                 <h1 id="typescript">TypeScript<a class="headerlink" href="#typescript" title="Permanent link">#</a></h1>
2038 <h2 id="consuming-woltlab-suites-types">Consuming WoltLab Suite’s Types<a class="headerlink" href="#consuming-woltlab-suites-types" title="Permanent link">#</a></h2>
2039 <p>To consume the types of WoltLab Suite, you will need to install the <code>@woltlab/wcf</code> npm package using a git URL that refers to the appropriate branch of <a href="https://github.com/WoltLab/WCF">WoltLab/WCF</a>.</p>
2040 <p>A full <code>package.json</code> that includes WoltLab Suite, TypeScript, eslint and Prettier could look like the following.</p>
2041 <div class="highlight"><pre><span></span><code><span class="p">{</span>
2042   <span class="nt">&quot;devDependencies&quot;</span><span class="p">:</span> <span class="p">{</span>
2043     <span class="nt">&quot;@typescript-eslint/eslint-plugin&quot;</span><span class="p">:</span> <span class="s2">&quot;^4.6.1&quot;</span><span class="p">,</span>
2044     <span class="nt">&quot;@typescript-eslint/parser&quot;</span><span class="p">:</span> <span class="s2">&quot;^4.6.1&quot;</span><span class="p">,</span>
2045     <span class="nt">&quot;eslint&quot;</span><span class="p">:</span> <span class="s2">&quot;^7.12.1&quot;</span><span class="p">,</span>
2046     <span class="nt">&quot;eslint-config-prettier&quot;</span><span class="p">:</span> <span class="s2">&quot;^6.15.0&quot;</span><span class="p">,</span>
2047     <span class="nt">&quot;prettier&quot;</span><span class="p">:</span> <span class="s2">&quot;^2.1.2&quot;</span><span class="p">,</span>
2048     <span class="nt">&quot;tslib&quot;</span><span class="p">:</span> <span class="s2">&quot;^2.0.3&quot;</span><span class="p">,</span>
2049     <span class="nt">&quot;typescript&quot;</span><span class="p">:</span> <span class="s2">&quot;^4.1.3&quot;</span>
2050   <span class="p">},</span>
2051   <span class="nt">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">{</span>
2052     <span class="nt">&quot;@woltlab/wcf&quot;</span><span class="p">:</span> <span class="s2">&quot;https://github.com/WoltLab/WCF.git#master&quot;</span>
2053   <span class="p">}</span>
2054 <span class="p">}</span>
2055 </code></pre></div>
2056 <p>After installing the types using npm, you will also need to configure <code>tsconfig.json</code> to take the types into account.
2057 To do so, you will need to add them to the <code>compilerOptions.paths</code> option.
2058 A complete <code>tsconfig.json</code> file that matches the configuration of WoltLab Suite could look like the following.</p>
2059 <div class="highlight"><pre><span></span><code><span class="p">{</span>
2060   <span class="nt">&quot;include&quot;</span><span class="p">:</span> <span class="p">[</span>
2061     <span class="s2">&quot;node_modules/@woltlab/wcf/global.d.ts&quot;</span><span class="p">,</span>
2062     <span class="s2">&quot;ts/**/*&quot;</span>
2063   <span class="p">],</span>
2064   <span class="nt">&quot;compilerOptions&quot;</span><span class="p">:</span> <span class="p">{</span>
2065     <span class="nt">&quot;target&quot;</span><span class="p">:</span> <span class="s2">&quot;es2017&quot;</span><span class="p">,</span>
2066     <span class="nt">&quot;module&quot;</span><span class="p">:</span> <span class="s2">&quot;amd&quot;</span><span class="p">,</span>
2067     <span class="nt">&quot;rootDir&quot;</span><span class="p">:</span> <span class="s2">&quot;ts/&quot;</span><span class="p">,</span>
2068     <span class="nt">&quot;outDir&quot;</span><span class="p">:</span> <span class="s2">&quot;files/js/&quot;</span><span class="p">,</span>
2069     <span class="nt">&quot;lib&quot;</span><span class="p">:</span> <span class="p">[</span>
2070       <span class="s2">&quot;dom&quot;</span><span class="p">,</span>
2071       <span class="s2">&quot;es2017&quot;</span>
2072     <span class="p">],</span>
2073     <span class="nt">&quot;strictNullChecks&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2074     <span class="nt">&quot;moduleResolution&quot;</span><span class="p">:</span> <span class="s2">&quot;node&quot;</span><span class="p">,</span>
2075     <span class="nt">&quot;esModuleInterop&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2076     <span class="nt">&quot;noImplicitThis&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2077     <span class="nt">&quot;strictBindCallApply&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2078     <span class="nt">&quot;baseUrl&quot;</span><span class="p">:</span> <span class="s2">&quot;.&quot;</span><span class="p">,</span>
2079     <span class="nt">&quot;paths&quot;</span><span class="p">:</span> <span class="p">{</span>
2080       <span class="nt">&quot;*&quot;</span><span class="p">:</span> <span class="p">[</span>
2081         <span class="s2">&quot;node_modules/@woltlab/wcf/ts/*&quot;</span>
2082       <span class="p">]</span>
2083     <span class="p">},</span>
2084     <span class="nt">&quot;importHelpers&quot;</span><span class="p">:</span> <span class="kc">true</span>
2085   <span class="p">}</span>
2086 <span class="p">}</span>
2087 </code></pre></div>
2088 <p>After this initial set-up, you would place your TypeScript source files into the <code>ts/</code> folder of your project.
2089 The generated JavaScript target files will be placed into <code>files/js/</code> and thus will be installed by the <a href="../../package/pip/file/">file PIP</a>.</p>
2090 <h2 id="additional-tools">Additional Tools<a class="headerlink" href="#additional-tools" title="Permanent link">#</a></h2>
2091 <p>WoltLab Suite uses additional tools to ensure the high quality and a consistent code style of the TypeScript modules.
2092 The current configuration of these tools is as follows.
2093 It is recommended to re-use this configuration as is.</p>
2094 <h3 id="prettierrc">.prettierrc<a class="headerlink" href="#prettierrc" title="Permanent link">#</a></h3>
2095 <div class="highlight"><pre><span></span><code>trailingComma: all
2096 printWidth: 120
2097 </code></pre></div>
2098 <h3 id="eslintrcjs">.eslintrc.js<a class="headerlink" href="#eslintrcjs" title="Permanent link">#</a></h3>
2099 <div class="highlight"><pre><span></span><code><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="p">{</span>
2100   <span class="nx">root</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
2101   <span class="nx">parser</span><span class="o">:</span> <span class="s2">&quot;@typescript-eslint/parser&quot;</span><span class="p">,</span>
2102   <span class="nx">parserOptions</span><span class="o">:</span> <span class="p">{</span>
2103     <span class="nx">tsconfigRootDir</span><span class="o">:</span> <span class="nx">__dirname</span><span class="p">,</span>
2104     <span class="nx">project</span><span class="o">:</span> <span class="p">[</span><span class="s2">&quot;./tsconfig.json&quot;</span><span class="p">]</span>
2105   <span class="p">},</span>
2106   <span class="nx">plugins</span><span class="o">:</span> <span class="p">[</span><span class="s2">&quot;@typescript-eslint&quot;</span><span class="p">],</span>
2107   <span class="k">extends</span><span class="o">:</span> <span class="p">[</span>
2108     <span class="s2">&quot;eslint:recommended&quot;</span><span class="p">,</span>
2109     <span class="s2">&quot;plugin:@typescript-eslint/recommended&quot;</span><span class="p">,</span>
2110     <span class="s2">&quot;plugin:@typescript-eslint/recommended-requiring-type-checking&quot;</span><span class="p">,</span>
2111     <span class="s2">&quot;prettier&quot;</span><span class="p">,</span>
2112     <span class="s2">&quot;prettier/@typescript-eslint&quot;</span>
2113   <span class="p">],</span>
2114   <span class="nx">rules</span><span class="o">:</span> <span class="p">{</span>
2115     <span class="s2">&quot;@typescript-eslint/ban-types&quot;</span><span class="o">:</span> <span class="p">[</span>
2116       <span class="s2">&quot;error&quot;</span><span class="p">,</span> <span class="p">{</span>
2117         <span class="nx">types</span><span class="o">:</span> <span class="p">{</span>
2118           <span class="s2">&quot;object&quot;</span><span class="o">:</span> <span class="kc">false</span>
2119         <span class="p">},</span>
2120         <span class="nx">extendDefaults</span><span class="o">:</span> <span class="kc">true</span>
2121       <span class="p">}</span>
2122     <span class="p">],</span>
2123     <span class="s2">&quot;@typescript-eslint/no-explicit-any&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2124     <span class="s2">&quot;@typescript-eslint/no-non-null-assertion&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2125     <span class="s2">&quot;@typescript-eslint/no-unsafe-assignment&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2126     <span class="s2">&quot;@typescript-eslint/no-unsafe-call&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2127     <span class="s2">&quot;@typescript-eslint/no-unsafe-member-access&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2128     <span class="s2">&quot;@typescript-eslint/no-unsafe-return&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2129     <span class="s2">&quot;@typescript-eslint/no-unused-vars&quot;</span><span class="o">:</span> <span class="p">[</span>
2130       <span class="s2">&quot;error&quot;</span><span class="p">,</span> <span class="p">{</span>
2131         <span class="s2">&quot;argsIgnorePattern&quot;</span><span class="o">:</span> <span class="s2">&quot;^_&quot;</span>
2132       <span class="p">}</span>
2133     <span class="p">]</span>
2134   <span class="p">}</span>
2135 <span class="p">};</span>
2136 </code></pre></div>
2137 <h3 id="eslintignore">.eslintignore<a class="headerlink" href="#eslintignore" title="Permanent link">#</a></h3>
2138 <div class="highlight"><pre><span></span><code>**/*.js
2139 </code></pre></div>
2140 <h3 id="gitattributes">.gitattributes<a class="headerlink" href="#gitattributes" title="Permanent link">#</a></h3>
2141 <p>This <code>.gitattributes</code> configuration will automatically collapse the generated JavaScript target files in GitHub’s Diff view.
2142 You will not need it if you do not use git or GitHub.</p>
2143 <div class="highlight"><pre><span></span><code>files/js/**/*.js linguist-generated
2144 </code></pre></div>
2145 <h2 id="writing-a-simple-module">Writing a simple module<a class="headerlink" href="#writing-a-simple-module" title="Permanent link">#</a></h2>
2146 <p>After completing this initial set-up you can start writing your first TypeScript module.
2147 The TypeScript compiler can be launched in Watch Mode by running <code>npx tsc -w</code>.</p>
2148 <p>WoltLab Suite’s modules can be imported using the standard ECMAScript module import syntax by specifying the full module name.
2149 The public API of the module can also be exported using the standard ECMAScript module export syntax.</p>
2150 <div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="o">*</span> <span class="kr">as</span> <span class="nx">Language</span> <span class="nx">from</span> <span class="s2">&quot;WoltLabSuite/Core/Language&quot;</span><span class="p">;</span>
2151
2152 <span class="k">export</span> <span class="kd">function</span> <span class="nx">run</span><span class="p">()</span> <span class="p">{</span>
2153   <span class="nx">alert</span><span class="p">(</span><span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;wcf.foo.bar&quot;</span><span class="p">));</span>
2154 <span class="p">}</span>
2155 </code></pre></div>
2156 <p>This simple example module will compile to plain JavaScript that is compatible with the AMD loader that is used by WoltLab Suite.</p>
2157 <div class="highlight"><pre><span></span><code><span class="nx">define</span><span class="p">([</span><span class="s2">&quot;require&quot;</span><span class="p">,</span> <span class="s2">&quot;exports&quot;</span><span class="p">,</span> <span class="s2">&quot;tslib&quot;</span><span class="p">,</span> <span class="s2">&quot;WoltLabSuite/Core/Language&quot;</span><span class="p">],</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">require</span><span class="p">,</span> <span class="nx">exports</span><span class="p">,</span> <span class="nx">tslib_1</span><span class="p">,</span> <span class="nx">Language</span><span class="p">)</span> <span class="p">{</span>
2158     <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2159     <span class="nb">Object</span><span class="p">.</span><span class="nx">defineProperty</span><span class="p">(</span><span class="nx">exports</span><span class="p">,</span> <span class="s2">&quot;__esModule&quot;</span><span class="p">,</span> <span class="p">{</span> <span class="nx">value</span><span class="o">:</span> <span class="kc">true</span> <span class="p">});</span>
2160     <span class="nx">exports</span><span class="p">.</span><span class="nx">run</span> <span class="o">=</span> <span class="k">void</span> <span class="mf">0</span><span class="p">;</span>
2161     <span class="nx">Language</span> <span class="o">=</span> <span class="nx">tslib_1</span><span class="p">.</span><span class="nx">__importStar</span><span class="p">(</span><span class="nx">Language</span><span class="p">);</span>
2162     <span class="kd">function</span> <span class="nx">run</span><span class="p">()</span> <span class="p">{</span>
2163         <span class="nx">alert</span><span class="p">(</span><span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;wcf.foo.bar&quot;</span><span class="p">));</span>
2164     <span class="p">}</span>
2165     <span class="nx">exports</span><span class="p">.</span><span class="nx">run</span> <span class="o">=</span> <span class="nx">run</span><span class="p">;</span>
2166 <span class="p">});</span>
2167 </code></pre></div>
2168 <p>Within templates it can be consumed as follows.</p>
2169 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">script</span> <span class="na">data-relocate</span><span class="o">=</span><span class="s">&quot;true&quot;</span><span class="p">&gt;</span>
2170   <span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Example&quot;</span><span class="p">],</span> <span class="p">(</span><span class="nx">Example</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="p">{</span>
2171     <span class="nx">Example</span><span class="p">.</span><span class="nx">run</span><span class="p">();</span> <span class="c1">// Alerts the contents of the `wcf.foo.bar` phrase.</span>
2172   <span class="p">});</span>
2173 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2174 </code></pre></div>
2175
2176
2177
2178
2179 <hr>
2180 <div class="md-source-date">
2181   <small>
2182
2183       Last update: 2021-04-13
2184
2185   </small>
2186 </div>
2187
2188
2189
2190
2191
2192
2193
2194
2195             </article>
2196           </div>
2197         </div>
2198
2199       </main>
2200
2201
2202 <footer class="md-footer">
2203
2204     <nav class="md-footer__inner md-grid" aria-label="Footer">
2205
2206         <a href="../general-usage/" class="md-footer__link md-footer__link--prev" rel="prev">
2207           <div class="md-footer__button md-icon">
2208             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2209           </div>
2210           <div class="md-footer__title">
2211             <div class="md-ellipsis">
2212               <span class="md-footer__direction">
2213                 Previous
2214               </span>
2215               General Usage
2216             </div>
2217           </div>
2218         </a>
2219
2220
2221         <a href="../new-api_writing-a-module/" class="md-footer__link md-footer__link--next" rel="next">
2222           <div class="md-footer__title">
2223             <div class="md-ellipsis">
2224               <span class="md-footer__direction">
2225                 Next
2226               </span>
2227               Writing a module
2228             </div>
2229           </div>
2230           <div class="md-footer__button md-icon">
2231             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2232           </div>
2233         </a>
2234
2235     </nav>
2236
2237   <div class="md-footer-meta md-typeset">
2238     <div class="md-footer-meta__inner md-grid">
2239       <div class="md-footer-copyright">
2240
2241           <div class="md-footer-copyright__highlight">
2242             Copyright © 2020 WoltLab GmbH
2243           </div>
2244
2245         Made with
2246         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2247           Material for MkDocs
2248         </a>
2249
2250       </div>
2251       <div class="md-footer-copyright">
2252         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2253         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2254 </div>
2255     </div>
2256   </div>
2257 </footer>
2258
2259     </div>
2260     <div class="md-dialog" data-md-component="dialog">
2261       <div class="md-dialog__inner md-typeset"></div>
2262     </div>
2263     <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2264
2265
2266       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2267
2268
2269   </body>
2270 </html>