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