latest/javascript/new-api_data-structures/index.html

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