latest/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     <li class="md-nav__item">
 310       <a href="../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 613
 614
 615         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
 616
 617       <label class="md-nav__link" for="__nav_4">
 618         TypeScript and JavaScript API
 619         <span class="md-nav__icon md-icon"></span>
 620       </label>
 621       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 622         <label class="md-nav__title" for="__nav_4">
 623           <span class="md-nav__icon md-icon"></span>
 624           TypeScript and JavaScript API
 625         </label>
 626         <ul class="md-nav__list" data-md-scrollfix>
 627
 628
 629
 630
 631
 632     <li class="md-nav__item">
 633       <a href="../general-usage/" class="md-nav__link">
 634         General Usage
 635       </a>
 636     </li>
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item md-nav__item--active">
 647
 648       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 649
 650
 651
 652
 653         <label class="md-nav__link md-nav__link--active" for="__toc">
 654           TypeScript
 655           <span class="md-nav__icon md-icon"></span>
 656         </label>
 657
 658       <a href="./" class="md-nav__link md-nav__link--active">
 659         TypeScript
 660       </a>
 661
 662
 663 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 664
 665
 666
 667
 668
 669     <label class="md-nav__title" for="__toc">
 670       <span class="md-nav__icon md-icon"></span>
 671       Table of contents
 672     </label>
 673     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 674
 675         <li class="md-nav__item">
 676   <a href="#consuming-woltlab-suites-types" class="md-nav__link">
 677     Consuming WoltLab Suite’s Types
 678   </a>
 679
 680 </li>
 681
 682         <li class="md-nav__item">
 683   <a href="#additional-tools" class="md-nav__link">
 684     Additional Tools
 685   </a>
 686
 687     <nav class="md-nav" aria-label="Additional Tools">
 688       <ul class="md-nav__list">
 689
 690           <li class="md-nav__item">
 691   <a href="#prettierrc" class="md-nav__link">
 692     .prettierrc
 693   </a>
 694
 695 </li>
 696
 697           <li class="md-nav__item">
 698   <a href="#eslintrcjs" class="md-nav__link">
 699     .eslintrc.js
 700   </a>
 701
 702 </li>
 703
 704           <li class="md-nav__item">
 705   <a href="#eslintignore" class="md-nav__link">
 706     .eslintignore
 707   </a>
 708
 709 </li>
 710
 711           <li class="md-nav__item">
 712   <a href="#gitattributes" class="md-nav__link">
 713     .gitattributes
 714   </a>
 715
 716 </li>
 717
 718       </ul>
 719     </nav>
 720
 721 </li>
 722
 723         <li class="md-nav__item">
 724   <a href="#writing-a-simple-module" class="md-nav__link">
 725     Writing a simple module
 726   </a>
 727
 728 </li>
 729
 730     </ul>
 731
 732 </nav>
 733
 734     </li>
 735
 736
 737
 738
 739
 740
 741
 742
 743     <li class="md-nav__item md-nav__item--nested">
 744
 745
 746         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 747
 748       <label class="md-nav__link" for="__nav_4_3">
 749         New API
 750         <span class="md-nav__icon md-icon"></span>
 751       </label>
 752       <nav class="md-nav" aria-label="New API" data-md-level="2">
 753         <label class="md-nav__title" for="__nav_4_3">
 754           <span class="md-nav__icon md-icon"></span>
 755           New API
 756         </label>
 757         <ul class="md-nav__list" data-md-scrollfix>
 758
 759
 760
 761
 762
 763     <li class="md-nav__item">
 764       <a href="../new-api_writing-a-module/" class="md-nav__link">
 765         Writing a module
 766       </a>
 767     </li>
 768
 769
 770
 771
 772
 773
 774
 775     <li class="md-nav__item">
 776       <a href="../new-api_data-structures/" class="md-nav__link">
 777         Data Structures
 778       </a>
 779     </li>
 780
 781
 782
 783
 784
 785
 786
 787     <li class="md-nav__item">
 788       <a href="../new-api_core/" class="md-nav__link">
 789         Core Functions
 790       </a>
 791     </li>
 792
 793
 794
 795
 796
 797
 798
 799     <li class="md-nav__item">
 800       <a href="../new-api_dom/" class="md-nav__link">
 801         DOM
 802       </a>
 803     </li>
 804
 805
 806
 807
 808
 809
 810
 811     <li class="md-nav__item">
 812       <a href="../new-api_events/" class="md-nav__link">
 813         Event Handling
 814       </a>
 815     </li>
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item">
 824       <a href="../new-api_ajax/" class="md-nav__link">
 825         Ajax
 826       </a>
 827     </li>
 828
 829
 830
 831
 832
 833
 834
 835     <li class="md-nav__item">
 836       <a href="../new-api_dialogs/" class="md-nav__link">
 837         Dialogs
 838       </a>
 839     </li>
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item">
 848       <a href="../new-api_browser/" class="md-nav__link">
 849         Browser and Screen Sizes
 850       </a>
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859     <li class="md-nav__item">
 860       <a href="../new-api_ui/" class="md-nav__link">
 861         User Interface
 862       </a>
 863     </li>
 864
 865
 866
 867         </ul>
 868       </nav>
 869     </li>
 870
 871
 872
 873
 874
 875
 876
 877     <li class="md-nav__item">
 878       <a href="../legacy-api/" class="md-nav__link">
 879         Legacy API
 880       </a>
 881     </li>
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../helper-functions/" class="md-nav__link">
 891         Helper Functions
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../code-snippets/" class="md-nav__link">
 903         Code Snippets
 904       </a>
 905     </li>
 906
 907
 908
 909         </ul>
 910       </nav>
 911     </li>
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923     <li class="md-nav__item md-nav__item--nested">
 924
 925
 926         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 927
 928       <label class="md-nav__link" for="__nav_5">
 929         Package Components
 930         <span class="md-nav__icon md-icon"></span>
 931       </label>
 932       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 933         <label class="md-nav__title" for="__nav_5">
 934           <span class="md-nav__icon md-icon"></span>
 935           Package Components
 936         </label>
 937         <ul class="md-nav__list" data-md-scrollfix>
 938
 939
 940
 941
 942
 943     <li class="md-nav__item">
 944       <a href="../../package/package-xml/" class="md-nav__link">
 945         package.xml
 946       </a>
 947     </li>
 948
 949
 950
 951
 952
 953
 954
 955
 956     <li class="md-nav__item md-nav__item--nested">
 957
 958
 959         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 960
 961       <label class="md-nav__link" for="__nav_5_2">
 962         PIPs
 963         <span class="md-nav__icon md-icon"></span>
 964       </label>
 965       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 966         <label class="md-nav__title" for="__nav_5_2">
 967           <span class="md-nav__icon md-icon"></span>
 968           PIPs
 969         </label>
 970         <ul class="md-nav__list" data-md-scrollfix>
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../../package/pip/" class="md-nav__link">
 978         Overview
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../../package/pip/acl-option/" class="md-nav__link">
 990         aclOption
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1002         acpMenu
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1014         acpSearchProvider
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../../package/pip/acp-template/" class="md-nav__link">
1026         acpTemplate
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../../package/pip/bbcode/" class="md-nav__link">
1038         bbcode
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../../package/pip/box/" class="md-nav__link">
1050         box
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1062         clipboardAction
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../../package/pip/core-object/" class="md-nav__link">
1074         coreObject
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../../package/pip/cronjob/" class="md-nav__link">
1086         cronjob
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../package/pip/event-listener/" class="md-nav__link">
1098         eventListener
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../../package/pip/file/" class="md-nav__link">
1110         file
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="../../package/pip/language/" class="md-nav__link">
1122         language
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="../../package/pip/media-provider/" class="md-nav__link">
1134         mediaProvider
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="../../package/pip/menu/" class="md-nav__link">
1146         menu
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="../../package/pip/menu-item/" class="md-nav__link">
1158         menuItem
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../../package/pip/object-type/" class="md-nav__link">
1170         objectType
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1182         objectTypeDefinition
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../../package/pip/option/" class="md-nav__link">
1194         option
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../../package/pip/page/" class="md-nav__link">
1206         page
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../../package/pip/pip/" class="md-nav__link">
1218         pip
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../package/pip/script/" class="md-nav__link">
1230         script
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="../../package/pip/smiley/" class="md-nav__link">
1242         smiley
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../../package/pip/sql/" class="md-nav__link">
1254         sql
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../../package/pip/style/" class="md-nav__link">
1266         style
1267       </a>
1268     </li>
1269
1270
1271
1272
1273
1274
1275
1276     <li class="md-nav__item">
1277       <a href="../../package/pip/template/" class="md-nav__link">
1278         template
1279       </a>
1280     </li>
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../../package/pip/template-listener/" class="md-nav__link">
1290         templateListener
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300     <li class="md-nav__item">
1301       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1302         userGroupOption
1303       </a>
1304     </li>
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../package/pip/user-menu/" class="md-nav__link">
1314         userMenu
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324     <li class="md-nav__item">
1325       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1326         userNotificationEvent
1327       </a>
1328     </li>
1329
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item">
1337       <a href="../../package/pip/user-option/" class="md-nav__link">
1338         userOption
1339       </a>
1340     </li>
1341
1342
1343
1344
1345
1346
1347
1348     <li class="md-nav__item">
1349       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1350         userProfileMenu
1351       </a>
1352     </li>
1353
1354
1355
1356         </ul>
1357       </nav>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366     <li class="md-nav__item">
1367       <a href="../../package/database-php-api/" class="md-nav__link">
1368         Database PHP API
1369       </a>
1370     </li>
1371
1372
1373
1374         </ul>
1375       </nav>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388     <li class="md-nav__item md-nav__item--nested">
1389
1390
1391         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1392
1393       <label class="md-nav__link" for="__nav_6">
1394         Migration
1395         <span class="md-nav__icon md-icon"></span>
1396       </label>
1397       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1398         <label class="md-nav__title" for="__nav_6">
1399           <span class="md-nav__icon md-icon"></span>
1400           Migration
1401         </label>
1402         <ul class="md-nav__list" data-md-scrollfix>
1403
1404
1405
1406
1407
1408
1409     <li class="md-nav__item md-nav__item--nested">
1410
1411
1412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1413
1414       <label class="md-nav__link" for="__nav_6_1">
1415         Migrating from WSC 5.3
1416         <span class="md-nav__icon md-icon"></span>
1417       </label>
1418       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1419         <label class="md-nav__title" for="__nav_6_1">
1420           <span class="md-nav__icon md-icon"></span>
1421           Migrating from WSC 5.3
1422         </label>
1423         <ul class="md-nav__list" data-md-scrollfix>
1424
1425
1426
1427
1428
1429     <li class="md-nav__item">
1430       <a href="../../migration/wsc53/php/" class="md-nav__link">
1431         PHP API
1432       </a>
1433     </li>
1434
1435
1436
1437
1438
1439
1440
1441     <li class="md-nav__item">
1442       <a href="../../migration/wsc53/session/" class="md-nav__link">
1443         Session Handling and Authentication
1444       </a>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453     <li class="md-nav__item">
1454       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1455         TypeScript and JavaScript
1456       </a>
1457     </li>
1458
1459
1460
1461
1462
1463
1464
1465     <li class="md-nav__item">
1466       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1467         Templates
1468       </a>
1469     </li>
1470
1471
1472
1473
1474
1475
1476
1477     <li class="md-nav__item">
1478       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1479         Third Party Libraries
1480       </a>
1481     </li>
1482
1483
1484
1485         </ul>
1486       </nav>
1487     </li>
1488
1489
1490
1491
1492
1493
1494
1495
1496     <li class="md-nav__item md-nav__item--nested">
1497
1498
1499         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1500
1501       <label class="md-nav__link" for="__nav_6_2">
1502         Migrating from WSC 5.2
1503         <span class="md-nav__icon md-icon"></span>
1504       </label>
1505       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1506         <label class="md-nav__title" for="__nav_6_2">
1507           <span class="md-nav__icon md-icon"></span>
1508           Migrating from WSC 5.2
1509         </label>
1510         <ul class="md-nav__list" data-md-scrollfix>
1511
1512
1513
1514
1515
1516     <li class="md-nav__item">
1517       <a href="../../migration/wsc52/php/" class="md-nav__link">
1518         PHP API
1519       </a>
1520     </li>
1521
1522
1523
1524
1525
1526
1527
1528     <li class="md-nav__item">
1529       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1530         Templates and Languages
1531       </a>
1532     </li>
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1542         Third Party Libraries
1543       </a>
1544     </li>
1545
1546
1547
1548         </ul>
1549       </nav>
1550     </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559     <li class="md-nav__item md-nav__item--nested">
1560
1561
1562         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1563
1564       <label class="md-nav__link" for="__nav_6_3">
1565         Migrating from WSC 3.1
1566         <span class="md-nav__icon md-icon"></span>
1567       </label>
1568       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1569         <label class="md-nav__title" for="__nav_6_3">
1570           <span class="md-nav__icon md-icon"></span>
1571           Migrating from WSC 3.1
1572         </label>
1573         <ul class="md-nav__list" data-md-scrollfix>
1574
1575
1576
1577
1578
1579     <li class="md-nav__item">
1580       <a href="../../migration/wsc31/php/" class="md-nav__link">
1581         PHP API
1582       </a>
1583     </li>
1584
1585
1586
1587         </ul>
1588       </nav>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597
1598     <li class="md-nav__item md-nav__item--nested">
1599
1600
1601         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1602
1603       <label class="md-nav__link" for="__nav_6_4">
1604         Migrating from WSC 3.0
1605         <span class="md-nav__icon md-icon"></span>
1606       </label>
1607       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1608         <label class="md-nav__title" for="__nav_6_4">
1609           <span class="md-nav__icon md-icon"></span>
1610           Migrating from WSC 3.0
1611         </label>
1612         <ul class="md-nav__list" data-md-scrollfix>
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../../migration/wsc30/php/" class="md-nav__link">
1620         PHP API
1621       </a>
1622     </li>
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1632         JavaScript API
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642     <li class="md-nav__item">
1643       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1644         Templates
1645       </a>
1646     </li>
1647
1648
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../migration/wsc30/css/" class="md-nav__link">
1656         CSS
1657       </a>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666     <li class="md-nav__item">
1667       <a href="../../migration/wsc30/package/" class="md-nav__link">
1668         Package Components
1669       </a>
1670     </li>
1671
1672
1673
1674         </ul>
1675       </nav>
1676     </li>
1677
1678
1679
1680
1681
1682
1683
1684
1685     <li class="md-nav__item md-nav__item--nested">
1686
1687
1688         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1689
1690       <label class="md-nav__link" for="__nav_6_5">
1691         Migrating from WCF 2.1
1692         <span class="md-nav__icon md-icon"></span>
1693       </label>
1694       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1695         <label class="md-nav__title" for="__nav_6_5">
1696           <span class="md-nav__icon md-icon"></span>
1697           Migrating from WCF 2.1
1698         </label>
1699         <ul class="md-nav__list" data-md-scrollfix>
1700
1701
1702
1703
1704
1705     <li class="md-nav__item">
1706       <a href="../../migration/wcf21/php/" class="md-nav__link">
1707         PHP API
1708       </a>
1709     </li>
1710
1711
1712
1713
1714
1715
1716
1717     <li class="md-nav__item">
1718       <a href="../../migration/wcf21/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/wcf21/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/wcf21/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         </ul>
1756       </nav>
1757     </li>
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769     <li class="md-nav__item md-nav__item--nested">
1770
1771
1772         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1773
1774       <label class="md-nav__link" for="__nav_7">
1775         Tutorials
1776         <span class="md-nav__icon md-icon"></span>
1777       </label>
1778       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1779         <label class="md-nav__title" for="__nav_7">
1780           <span class="md-nav__icon md-icon"></span>
1781           Tutorials
1782         </label>
1783         <ul class="md-nav__list" data-md-scrollfix>
1784
1785
1786
1787
1788
1789
1790     <li class="md-nav__item md-nav__item--nested">
1791
1792
1793         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1794
1795       <label class="md-nav__link" for="__nav_7_1">
1796         Tutorial Series
1797         <span class="md-nav__icon md-icon"></span>
1798       </label>
1799       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1800         <label class="md-nav__title" for="__nav_7_1">
1801           <span class="md-nav__icon md-icon"></span>
1802           Tutorial Series
1803         </label>
1804         <ul class="md-nav__list" data-md-scrollfix>
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../../tutorial/series/overview/" class="md-nav__link">
1812         Overview
1813       </a>
1814     </li>
1815
1816
1817
1818
1819
1820
1821
1822     <li class="md-nav__item">
1823       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1824         Part 1
1825       </a>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834     <li class="md-nav__item">
1835       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1836         Part 2
1837       </a>
1838     </li>
1839
1840
1841
1842
1843
1844
1845
1846     <li class="md-nav__item">
1847       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1848         Part 3
1849       </a>
1850     </li>
1851
1852
1853
1854         </ul>
1855       </nav>
1856     </li>
1857
1858
1859
1860         </ul>
1861       </nav>
1862     </li>
1863
1864
1865
1866   </ul>
1867 </nav>
1868                   </div>
1869                 </div>
1870               </div>
1871
1872
1873
1874               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1875                 <div class="md-sidebar__scrollwrap">
1876                   <div class="md-sidebar__inner">
1877
1878 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1879
1880
1881
1882
1883
1884     <label class="md-nav__title" for="__toc">
1885       <span class="md-nav__icon md-icon"></span>
1886       Table of contents
1887     </label>
1888     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1889
1890         <li class="md-nav__item">
1891   <a href="#consuming-woltlab-suites-types" class="md-nav__link">
1892     Consuming WoltLab Suite’s Types
1893   </a>
1894
1895 </li>
1896
1897         <li class="md-nav__item">
1898   <a href="#additional-tools" class="md-nav__link">
1899     Additional Tools
1900   </a>
1901
1902     <nav class="md-nav" aria-label="Additional Tools">
1903       <ul class="md-nav__list">
1904
1905           <li class="md-nav__item">
1906   <a href="#prettierrc" class="md-nav__link">
1907     .prettierrc
1908   </a>
1909
1910 </li>
1911
1912           <li class="md-nav__item">
1913   <a href="#eslintrcjs" class="md-nav__link">
1914     .eslintrc.js
1915   </a>
1916
1917 </li>
1918
1919           <li class="md-nav__item">
1920   <a href="#eslintignore" class="md-nav__link">
1921     .eslintignore
1922   </a>
1923
1924 </li>
1925
1926           <li class="md-nav__item">
1927   <a href="#gitattributes" class="md-nav__link">
1928     .gitattributes
1929   </a>
1930
1931 </li>
1932
1933       </ul>
1934     </nav>
1935
1936 </li>
1937
1938         <li class="md-nav__item">
1939   <a href="#writing-a-simple-module" class="md-nav__link">
1940     Writing a simple module
1941   </a>
1942
1943 </li>
1944
1945     </ul>
1946
1947 </nav>
1948                   </div>
1949                 </div>
1950               </div>
1951
1952
1953           <div class="md-content" data-md-component="content">
1954             <article class="md-content__inner md-typeset">
1955
1956
1957                   <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">
1958                     <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>
1959                   </a>
1960
1961
1962                 <h1 id="typescript">TypeScript<a class="headerlink" href="#typescript" title="Permanent link">#</a></h1>
1963 <h2 id="consuming-woltlab-suites-types">Consuming WoltLab Suite’s Types<a class="headerlink" href="#consuming-woltlab-suites-types" title="Permanent link">#</a></h2>
1964 <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>
1965 <p>A full <code>package.json</code> that includes WoltLab Suite, TypeScript, eslint and Prettier could look like the following.</p>
1966 <div class="highlight"><pre><span></span><code><span class="p">{</span>
1967   <span class="nt">&quot;devDependencies&quot;</span><span class="p">:</span> <span class="p">{</span>
1968     <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>
1969     <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>
1970     <span class="nt">&quot;eslint&quot;</span><span class="p">:</span> <span class="s2">&quot;^7.12.1&quot;</span><span class="p">,</span>
1971     <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>
1972     <span class="nt">&quot;prettier&quot;</span><span class="p">:</span> <span class="s2">&quot;^2.1.2&quot;</span><span class="p">,</span>
1973     <span class="nt">&quot;tslib&quot;</span><span class="p">:</span> <span class="s2">&quot;^2.0.3&quot;</span><span class="p">,</span>
1974     <span class="nt">&quot;typescript&quot;</span><span class="p">:</span> <span class="s2">&quot;^4.1.3&quot;</span>
1975   <span class="p">},</span>
1976   <span class="nt">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">{</span>
1977     <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>
1978   <span class="p">}</span>
1979 <span class="p">}</span>
1980 </code></pre></div>
1981 <p>After installing the types using npm, you will also need to configure <code>tsconfig.json</code> to take the types into account.
1982 To do so, you will need to add them to the <code>compilerOptions.paths</code> option.
1983 A complete <code>tsconfig.json</code> file that matches the configuration of WoltLab Suite could look like the following.</p>
1984 <div class="highlight"><pre><span></span><code><span class="p">{</span>
1985   <span class="nt">&quot;include&quot;</span><span class="p">:</span> <span class="p">[</span>
1986     <span class="s2">&quot;node_modules/@woltlab/wcf/global.d.ts&quot;</span><span class="p">,</span>
1987     <span class="s2">&quot;ts/**/*&quot;</span>
1988   <span class="p">],</span>
1989   <span class="nt">&quot;compilerOptions&quot;</span><span class="p">:</span> <span class="p">{</span>
1990     <span class="nt">&quot;target&quot;</span><span class="p">:</span> <span class="s2">&quot;es2017&quot;</span><span class="p">,</span>
1991     <span class="nt">&quot;module&quot;</span><span class="p">:</span> <span class="s2">&quot;amd&quot;</span><span class="p">,</span>
1992     <span class="nt">&quot;rootDir&quot;</span><span class="p">:</span> <span class="s2">&quot;ts/&quot;</span><span class="p">,</span>
1993     <span class="nt">&quot;outDir&quot;</span><span class="p">:</span> <span class="s2">&quot;files/js/&quot;</span><span class="p">,</span>
1994     <span class="nt">&quot;lib&quot;</span><span class="p">:</span> <span class="p">[</span>
1995       <span class="s2">&quot;dom&quot;</span><span class="p">,</span>
1996       <span class="s2">&quot;es2017&quot;</span>
1997     <span class="p">],</span>
1998     <span class="nt">&quot;strictNullChecks&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
1999     <span class="nt">&quot;moduleResolution&quot;</span><span class="p">:</span> <span class="s2">&quot;node&quot;</span><span class="p">,</span>
2000     <span class="nt">&quot;esModuleInterop&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2001     <span class="nt">&quot;noImplicitThis&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2002     <span class="nt">&quot;strictBindCallApply&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
2003     <span class="nt">&quot;baseUrl&quot;</span><span class="p">:</span> <span class="s2">&quot;.&quot;</span><span class="p">,</span>
2004     <span class="nt">&quot;paths&quot;</span><span class="p">:</span> <span class="p">{</span>
2005       <span class="nt">&quot;*&quot;</span><span class="p">:</span> <span class="p">[</span>
2006         <span class="s2">&quot;node_modules/@woltlab/wcf/ts/*&quot;</span>
2007       <span class="p">]</span>
2008     <span class="p">},</span>
2009     <span class="nt">&quot;importHelpers&quot;</span><span class="p">:</span> <span class="kc">true</span>
2010   <span class="p">}</span>
2011 <span class="p">}</span>
2012 </code></pre></div>
2013 <p>After this initial set-up, you would place your TypeScript source files into the <code>ts/</code> folder of your project.
2014 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>
2015 <h2 id="additional-tools">Additional Tools<a class="headerlink" href="#additional-tools" title="Permanent link">#</a></h2>
2016 <p>WoltLab Suite uses additional tools to ensure the high quality and a consistent code style of the TypeScript modules.
2017 The current configuration of these tools is as follows.
2018 It is recommended to re-use this configuration as is.</p>
2019 <h3 id="prettierrc">.prettierrc<a class="headerlink" href="#prettierrc" title="Permanent link">#</a></h3>
2020 <div class="highlight"><pre><span></span><code>trailingComma: all
2021 printWidth: 120
2022 </code></pre></div>
2023 <h3 id="eslintrcjs">.eslintrc.js<a class="headerlink" href="#eslintrcjs" title="Permanent link">#</a></h3>
2024 <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>
2025   <span class="nx">root</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
2026   <span class="nx">parser</span><span class="o">:</span> <span class="s2">&quot;@typescript-eslint/parser&quot;</span><span class="p">,</span>
2027   <span class="nx">parserOptions</span><span class="o">:</span> <span class="p">{</span>
2028     <span class="nx">tsconfigRootDir</span><span class="o">:</span> <span class="nx">__dirname</span><span class="p">,</span>
2029     <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>
2030   <span class="p">},</span>
2031   <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>
2032   <span class="k">extends</span><span class="o">:</span> <span class="p">[</span>
2033     <span class="s2">&quot;eslint:recommended&quot;</span><span class="p">,</span>
2034     <span class="s2">&quot;plugin:@typescript-eslint/recommended&quot;</span><span class="p">,</span>
2035     <span class="s2">&quot;plugin:@typescript-eslint/recommended-requiring-type-checking&quot;</span><span class="p">,</span>
2036     <span class="s2">&quot;prettier&quot;</span><span class="p">,</span>
2037     <span class="s2">&quot;prettier/@typescript-eslint&quot;</span>
2038   <span class="p">],</span>
2039   <span class="nx">rules</span><span class="o">:</span> <span class="p">{</span>
2040     <span class="s2">&quot;@typescript-eslint/ban-types&quot;</span><span class="o">:</span> <span class="p">[</span>
2041       <span class="s2">&quot;error&quot;</span><span class="p">,</span> <span class="p">{</span>
2042         <span class="nx">types</span><span class="o">:</span> <span class="p">{</span>
2043           <span class="s2">&quot;object&quot;</span><span class="o">:</span> <span class="kc">false</span>
2044         <span class="p">},</span>
2045         <span class="nx">extendDefaults</span><span class="o">:</span> <span class="kc">true</span>
2046       <span class="p">}</span>
2047     <span class="p">],</span>
2048     <span class="s2">&quot;@typescript-eslint/no-explicit-any&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2049     <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>
2050     <span class="s2">&quot;@typescript-eslint/no-unsafe-assignment&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2051     <span class="s2">&quot;@typescript-eslint/no-unsafe-call&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2052     <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>
2053     <span class="s2">&quot;@typescript-eslint/no-unsafe-return&quot;</span><span class="o">:</span> <span class="mf">0</span><span class="p">,</span>
2054     <span class="s2">&quot;@typescript-eslint/no-unused-vars&quot;</span><span class="o">:</span> <span class="p">[</span>
2055       <span class="s2">&quot;error&quot;</span><span class="p">,</span> <span class="p">{</span>
2056         <span class="s2">&quot;argsIgnorePattern&quot;</span><span class="o">:</span> <span class="s2">&quot;^_&quot;</span>
2057       <span class="p">}</span>
2058     <span class="p">]</span>
2059   <span class="p">}</span>
2060 <span class="p">};</span>
2061 </code></pre></div>
2062 <h3 id="eslintignore">.eslintignore<a class="headerlink" href="#eslintignore" title="Permanent link">#</a></h3>
2063 <div class="highlight"><pre><span></span><code>**/*.js
2064 </code></pre></div>
2065 <h3 id="gitattributes">.gitattributes<a class="headerlink" href="#gitattributes" title="Permanent link">#</a></h3>
2066 <p>This <code>.gitattributes</code> configuration will automatically collapse the generated JavaScript target files in GitHub’s Diff view.
2067 You will not need it if you do not use git or GitHub.</p>
2068 <div class="highlight"><pre><span></span><code>files/js/**/*.js linguist-generated
2069 </code></pre></div>
2070 <h2 id="writing-a-simple-module">Writing a simple module<a class="headerlink" href="#writing-a-simple-module" title="Permanent link">#</a></h2>
2071 <p>After completing this initial set-up you can start writing your first TypeScript module.
2072 The TypeScript compiler can be launched in Watch Mode by running <code>npx tsc -w</code>.</p>
2073 <p>WoltLab Suite’s modules can be imported using the standard ECMAScript module import syntax by specifying the full module name.
2074 The public API of the module can also be exported using the standard ECMASCript module export syntax.</p>
2075 <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>
2076
2077 <span class="k">export</span> <span class="kd">function</span> <span class="nx">run</span><span class="p">()</span> <span class="p">{</span>
2078   <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>
2079 <span class="p">}</span>
2080 </code></pre></div>
2081 <p>This simple example module will compile to plain JavaScript that is compatible with the AMD loader that is used by WoltLab Suite.</p>
2082 <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>
2083     <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2084     <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>
2085     <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>
2086     <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>
2087     <span class="kd">function</span> <span class="nx">run</span><span class="p">()</span> <span class="p">{</span>
2088         <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>
2089     <span class="p">}</span>
2090     <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>
2091 <span class="p">});</span>
2092 </code></pre></div>
2093 <p>Within templates it can be consumed as follows.</p>
2094 <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>
2095   <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>
2096     <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>
2097   <span class="p">});</span>
2098 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2099 </code></pre></div>
2100
2101
2102
2103
2104 <hr>
2105 <div class="md-source-date">
2106   <small>
2107
2108       Last update: 2021-04-13
2109
2110   </small>
2111 </div>
2112
2113
2114
2115
2116
2117
2118
2119
2120             </article>
2121           </div>
2122         </div>
2123
2124       </main>
2125
2126
2127 <footer class="md-footer">
2128
2129     <nav class="md-footer__inner md-grid" aria-label="Footer">
2130
2131         <a href="../general-usage/" class="md-footer__link md-footer__link--prev" rel="prev">
2132           <div class="md-footer__button md-icon">
2133             <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>
2134           </div>
2135           <div class="md-footer__title">
2136             <div class="md-ellipsis">
2137               <span class="md-footer__direction">
2138                 Previous
2139               </span>
2140               General Usage
2141             </div>
2142           </div>
2143         </a>
2144
2145
2146         <a href="../new-api_writing-a-module/" class="md-footer__link md-footer__link--next" rel="next">
2147           <div class="md-footer__title">
2148             <div class="md-ellipsis">
2149               <span class="md-footer__direction">
2150                 Next
2151               </span>
2152               Writing a module
2153             </div>
2154           </div>
2155           <div class="md-footer__button md-icon">
2156             <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>
2157           </div>
2158         </a>
2159
2160     </nav>
2161
2162   <div class="md-footer-meta md-typeset">
2163     <div class="md-footer-meta__inner md-grid">
2164       <div class="md-footer-copyright">
2165
2166           <div class="md-footer-copyright__highlight">
2167             Copyright © 2020 WoltLab GmbH
2168           </div>
2169
2170         Made with
2171         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2172           Material for MkDocs
2173         </a>
2174
2175       </div>
2176       <div class="md-footer-copyright">
2177         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2178         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2179 </div>
2180     </div>
2181   </div>
2182 </footer>
2183
2184     </div>
2185     <div class="md-dialog" data-md-component="dialog">
2186       <div class="md-dialog__inner md-typeset"></div>
2187     </div>
2188     <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>
2189
2190
2191       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2192
2193
2194   </body>
2195 </html>