3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>TypeScript - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#typescript" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
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">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
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>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
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>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
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>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
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
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../view/css/" class=
"md-nav__link">
612 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
615 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
617 <label class=
"md-nav__link" for=
"__nav_4">
618 TypeScript and JavaScript API
619 <span class=
"md-nav__icon md-icon"></span>
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
626 <ul class=
"md-nav__list" data-md-scrollfix
>
632 <li class=
"md-nav__item">
633 <a href=
"../general-usage/" class=
"md-nav__link">
646 <li class=
"md-nav__item md-nav__item--active">
648 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
653 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
655 <span class=
"md-nav__icon md-icon"></span>
658 <a href=
"./" class=
"md-nav__link md-nav__link--active">
663 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
669 <label class=
"md-nav__title" for=
"__toc">
670 <span class=
"md-nav__icon md-icon"></span>
673 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
675 <li class=
"md-nav__item">
676 <a href=
"#consuming-woltlab-suites-types" class=
"md-nav__link">
677 Consuming WoltLab Suite’s Types
682 <li class=
"md-nav__item">
683 <a href=
"#additional-tools" class=
"md-nav__link">
687 <nav class=
"md-nav" aria-label=
"Additional Tools">
688 <ul class=
"md-nav__list">
690 <li class=
"md-nav__item">
691 <a href=
"#prettierrc" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"#eslintrcjs" class=
"md-nav__link">
704 <li class=
"md-nav__item">
705 <a href=
"#eslintignore" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"#gitattributes" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"#writing-a-simple-module" class=
"md-nav__link">
725 Writing a simple module
743 <li class=
"md-nav__item md-nav__item--nested">
746 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
748 <label class=
"md-nav__link" for=
"__nav_4_3">
750 <span class=
"md-nav__icon md-icon"></span>
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>
757 <ul class=
"md-nav__list" data-md-scrollfix
>
763 <li class=
"md-nav__item">
764 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
787 <li class=
"md-nav__item">
788 <a href=
"../new-api_core/" class=
"md-nav__link">
799 <li class=
"md-nav__item">
800 <a href=
"../new-api_dom/" class=
"md-nav__link">
811 <li class=
"md-nav__item">
812 <a href=
"../new-api_events/" class=
"md-nav__link">
823 <li class=
"md-nav__item">
824 <a href=
"../new-api_ajax/" class=
"md-nav__link">
835 <li class=
"md-nav__item">
836 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
847 <li class=
"md-nav__item">
848 <a href=
"../new-api_browser/" class=
"md-nav__link">
849 Browser and Screen Sizes
859 <li class=
"md-nav__item">
860 <a href=
"../new-api_ui/" class=
"md-nav__link">
877 <li class=
"md-nav__item">
878 <a href=
"../legacy-api/" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"../helper-functions/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../code-snippets/" class=
"md-nav__link">
923 <li class=
"md-nav__item md-nav__item--nested">
926 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
928 <label class=
"md-nav__link" for=
"__nav_5">
930 <span class=
"md-nav__icon md-icon"></span>
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>
937 <ul class=
"md-nav__list" data-md-scrollfix
>
943 <li class=
"md-nav__item">
944 <a href=
"../../package/package-xml/" class=
"md-nav__link">
956 <li class=
"md-nav__item md-nav__item--nested">
959 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
961 <label class=
"md-nav__link" for=
"__nav_5_2">
963 <span class=
"md-nav__icon md-icon"></span>
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>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
976 <li class=
"md-nav__item">
977 <a href=
"../../package/pip/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1182 objectTypeDefinition
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1326 userNotificationEvent
1336 <li class=
"md-nav__item">
1337 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1388 <li class=
"md-nav__item md-nav__item--nested">
1391 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1393 <label class=
"md-nav__link" for=
"__nav_6">
1395 <span class=
"md-nav__icon md-icon"></span>
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>
1402 <ul class=
"md-nav__list" data-md-scrollfix
>
1409 <li class=
"md-nav__item md-nav__item--nested">
1412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
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>
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
1423 <ul class=
"md-nav__list" data-md-scrollfix
>
1429 <li class=
"md-nav__item">
1430 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1443 Session Handling and Authentication
1453 <li class=
"md-nav__item">
1454 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1455 TypeScript and JavaScript
1465 <li class=
"md-nav__item">
1466 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1479 Third Party Libraries
1496 <li class=
"md-nav__item md-nav__item--nested">
1499 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
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>
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
1510 <ul class=
"md-nav__list" data-md-scrollfix
>
1516 <li class=
"md-nav__item">
1517 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1530 Templates and Languages
1540 <li class=
"md-nav__item">
1541 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1542 Third Party Libraries
1559 <li class=
"md-nav__item md-nav__item--nested">
1562 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
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>
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
1573 <ul class=
"md-nav__list" data-md-scrollfix
>
1579 <li class=
"md-nav__item">
1580 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1598 <li class=
"md-nav__item md-nav__item--nested">
1601 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
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>
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
1612 <ul class=
"md-nav__list" data-md-scrollfix
>
1618 <li class=
"md-nav__item">
1619 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1630 <li class=
"md-nav__item">
1631 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1642 <li class=
"md-nav__item">
1643 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1685 <li class=
"md-nav__item md-nav__item--nested">
1688 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
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>
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
1699 <ul class=
"md-nav__list" data-md-scrollfix
>
1705 <li class=
"md-nav__item">
1706 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1717 <li class=
"md-nav__item">
1718 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1729 <li class=
"md-nav__item">
1730 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1741 <li class=
"md-nav__item">
1742 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1769 <li class=
"md-nav__item md-nav__item--nested">
1772 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1774 <label class=
"md-nav__link" for=
"__nav_7">
1776 <span class=
"md-nav__icon md-icon"></span>
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>
1783 <ul class=
"md-nav__list" data-md-scrollfix
>
1790 <li class=
"md-nav__item md-nav__item--nested">
1793 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1795 <label class=
"md-nav__link" for=
"__nav_7_1">
1797 <span class=
"md-nav__icon md-icon"></span>
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>
1804 <ul class=
"md-nav__list" data-md-scrollfix
>
1810 <li class=
"md-nav__item">
1811 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1822 <li class=
"md-nav__item">
1823 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1834 <li class=
"md-nav__item">
1835 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1846 <li class=
"md-nav__item">
1847 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
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">
1878 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1884 <label class=
"md-nav__title" for=
"__toc">
1885 <span class=
"md-nav__icon md-icon"></span>
1888 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1890 <li class=
"md-nav__item">
1891 <a href=
"#consuming-woltlab-suites-types" class=
"md-nav__link">
1892 Consuming WoltLab Suite’s Types
1897 <li class=
"md-nav__item">
1898 <a href=
"#additional-tools" class=
"md-nav__link">
1902 <nav class=
"md-nav" aria-label=
"Additional Tools">
1903 <ul class=
"md-nav__list">
1905 <li class=
"md-nav__item">
1906 <a href=
"#prettierrc" class=
"md-nav__link">
1912 <li class=
"md-nav__item">
1913 <a href=
"#eslintrcjs" class=
"md-nav__link">
1919 <li class=
"md-nav__item">
1920 <a href=
"#eslintignore" class=
"md-nav__link">
1926 <li class=
"md-nav__item">
1927 <a href=
"#gitattributes" class=
"md-nav__link">
1938 <li class=
"md-nav__item">
1939 <a href=
"#writing-a-simple-module" class=
"md-nav__link">
1940 Writing a simple module
1953 <div class=
"md-content" data-md-component=
"content">
1954 <article class=
"md-content__inner md-typeset">
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>
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">"devDependencies
"</span><span class=
"p">:
</span> <span class=
"p">{
</span>
1968 <span class=
"nt">"@typescript-eslint/eslint-plugin
"</span><span class=
"p">:
</span> <span class=
"s2">"^
4.6.1"</span><span class=
"p">,
</span>
1969 <span class=
"nt">"@typescript-eslint/parser
"</span><span class=
"p">:
</span> <span class=
"s2">"^
4.6.1"</span><span class=
"p">,
</span>
1970 <span class=
"nt">"eslint
"</span><span class=
"p">:
</span> <span class=
"s2">"^
7.12.1"</span><span class=
"p">,
</span>
1971 <span class=
"nt">"eslint-config-prettier
"</span><span class=
"p">:
</span> <span class=
"s2">"^
6.15.0"</span><span class=
"p">,
</span>
1972 <span class=
"nt">"prettier
"</span><span class=
"p">:
</span> <span class=
"s2">"^
2.1.2"</span><span class=
"p">,
</span>
1973 <span class=
"nt">"tslib
"</span><span class=
"p">:
</span> <span class=
"s2">"^
2.0.3"</span><span class=
"p">,
</span>
1974 <span class=
"nt">"typescript
"</span><span class=
"p">:
</span> <span class=
"s2">"^
4.1.3"</span>
1975 <span class=
"p">},
</span>
1976 <span class=
"nt">"dependencies
"</span><span class=
"p">:
</span> <span class=
"p">{
</span>
1977 <span class=
"nt">"@woltlab/wcf
"</span><span class=
"p">:
</span> <span class=
"s2">"https://github.com/WoltLab/WCF.git#master
"</span>
1978 <span class=
"p">}
</span>
1979 <span class=
"p">}
</span>
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">"include
"</span><span class=
"p">:
</span> <span class=
"p">[
</span>
1986 <span class=
"s2">"node_modules/@woltlab/wcf/global.d.ts
"</span><span class=
"p">,
</span>
1987 <span class=
"s2">"ts/**/*
"</span>
1988 <span class=
"p">],
</span>
1989 <span class=
"nt">"compilerOptions
"</span><span class=
"p">:
</span> <span class=
"p">{
</span>
1990 <span class=
"nt">"target
"</span><span class=
"p">:
</span> <span class=
"s2">"es2017
"</span><span class=
"p">,
</span>
1991 <span class=
"nt">"module
"</span><span class=
"p">:
</span> <span class=
"s2">"amd
"</span><span class=
"p">,
</span>
1992 <span class=
"nt">"rootDir
"</span><span class=
"p">:
</span> <span class=
"s2">"ts/
"</span><span class=
"p">,
</span>
1993 <span class=
"nt">"outDir
"</span><span class=
"p">:
</span> <span class=
"s2">"files/js/
"</span><span class=
"p">,
</span>
1994 <span class=
"nt">"lib
"</span><span class=
"p">:
</span> <span class=
"p">[
</span>
1995 <span class=
"s2">"dom
"</span><span class=
"p">,
</span>
1996 <span class=
"s2">"es2017
"</span>
1997 <span class=
"p">],
</span>
1998 <span class=
"nt">"strictNullChecks
"</span><span class=
"p">:
</span> <span class=
"kc">true
</span><span class=
"p">,
</span>
1999 <span class=
"nt">"moduleResolution
"</span><span class=
"p">:
</span> <span class=
"s2">"node
"</span><span class=
"p">,
</span>
2000 <span class=
"nt">"esModuleInterop
"</span><span class=
"p">:
</span> <span class=
"kc">true
</span><span class=
"p">,
</span>
2001 <span class=
"nt">"noImplicitThis
"</span><span class=
"p">:
</span> <span class=
"kc">true
</span><span class=
"p">,
</span>
2002 <span class=
"nt">"strictBindCallApply
"</span><span class=
"p">:
</span> <span class=
"kc">true
</span><span class=
"p">,
</span>
2003 <span class=
"nt">"baseUrl
"</span><span class=
"p">:
</span> <span class=
"s2">".
"</span><span class=
"p">,
</span>
2004 <span class=
"nt">"paths
"</span><span class=
"p">:
</span> <span class=
"p">{
</span>
2005 <span class=
"nt">"*
"</span><span class=
"p">:
</span> <span class=
"p">[
</span>
2006 <span class=
"s2">"node_modules/@woltlab/wcf/ts/*
"</span>
2007 <span class=
"p">]
</span>
2008 <span class=
"p">},
</span>
2009 <span class=
"nt">"importHelpers
"</span><span class=
"p">:
</span> <span class=
"kc">true
</span>
2010 <span class=
"p">}
</span>
2011 <span class=
"p">}
</span>
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
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">"@typescript-eslint/parser
"</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">"./tsconfig.json
"</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">"@typescript-eslint
"</span><span class=
"p">],
</span>
2032 <span class=
"k">extends
</span><span class=
"o">:
</span> <span class=
"p">[
</span>
2033 <span class=
"s2">"eslint:recommended
"</span><span class=
"p">,
</span>
2034 <span class=
"s2">"plugin:@typescript-eslint/recommended
"</span><span class=
"p">,
</span>
2035 <span class=
"s2">"plugin:@typescript-eslint/recommended-requiring-type-checking
"</span><span class=
"p">,
</span>
2036 <span class=
"s2">"prettier
"</span><span class=
"p">,
</span>
2037 <span class=
"s2">"prettier/@typescript-eslint
"</span>
2038 <span class=
"p">],
</span>
2039 <span class=
"nx">rules
</span><span class=
"o">:
</span> <span class=
"p">{
</span>
2040 <span class=
"s2">"@typescript-eslint/ban-types
"</span><span class=
"o">:
</span> <span class=
"p">[
</span>
2041 <span class=
"s2">"error
"</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">"object
"</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">"@typescript-eslint/no-explicit-any
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2049 <span class=
"s2">"@typescript-eslint/no-non-null-assertion
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2050 <span class=
"s2">"@typescript-eslint/no-unsafe-assignment
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2051 <span class=
"s2">"@typescript-eslint/no-unsafe-call
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2052 <span class=
"s2">"@typescript-eslint/no-unsafe-member-access
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2053 <span class=
"s2">"@typescript-eslint/no-unsafe-return
"</span><span class=
"o">:
</span> <span class=
"mf">0</span><span class=
"p">,
</span>
2054 <span class=
"s2">"@typescript-eslint/no-unused-vars
"</span><span class=
"o">:
</span> <span class=
"p">[
</span>
2055 <span class=
"s2">"error
"</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2056 <span class=
"s2">"argsIgnorePattern
"</span><span class=
"o">:
</span> <span class=
"s2">"^_
"</span>
2057 <span class=
"p">}
</span>
2058 <span class=
"p">]
</span>
2059 <span class=
"p">}
</span>
2060 <span class=
"p">};
</span>
2062 <h3 id=
"eslintignore">.eslintignore
<a class=
"headerlink" href=
"#eslintignore" title=
"Permanent link">#
</a></h3>
2063 <div class=
"highlight"><pre><span></span><code>**/*.js
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
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">"WoltLabSuite/Core/Language
"</span><span class=
"p">;
</span>
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">"wcf.foo.bar
"</span><span class=
"p">));
</span>
2079 <span class=
"p">}
</span>
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">"require
"</span><span class=
"p">,
</span> <span class=
"s2">"exports
"</span><span class=
"p">,
</span> <span class=
"s2">"tslib
"</span><span class=
"p">,
</span> <span class=
"s2">"WoltLabSuite/Core/Language
"</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">"use strict
"</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">"__esModule
"</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">"wcf.foo.bar
"</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>
2093 <p>Within templates it can be consumed as follows.
</p>
2094 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2095 <span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Example
"</span><span class=
"p">],
</span> <span class=
"p">(
</span><span class=
"nx">Example
</span><span class=
"p">)
</span> <span class=
"p">=
></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"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2105 <div class=
"md-source-date">
2108 Last update:
2021-
04-
13
2127 <footer class=
"md-footer">
2129 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
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>
2135 <div class=
"md-footer__title">
2136 <div class=
"md-ellipsis">
2137 <span class=
"md-footer__direction">
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">
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>
2162 <div class=
"md-footer-meta md-typeset">
2163 <div class=
"md-footer-meta__inner md-grid">
2164 <div class=
"md-footer-copyright">
2166 <div class=
"md-footer-copyright__highlight">
2167 Copyright ©
2020 WoltLab GmbH
2171 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
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>
2185 <div class=
"md-dialog" data-md-component=
"dialog">
2186 <div class=
"md-dialog__inner md-typeset"></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>
2191 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>