| 1 | <!DOCTYPE html>
|
| 2 |
|
| 3 | <html lang="en">
|
| 4 | <head>
|
| 5 | <meta charset="utf-8">
|
| 6 | <meta name="viewport" content="width=device-width">
|
| 7 | <title>Documentation Namespace: date</title>
|
| 8 |
|
| 9 | |
| 10 | |
| 11 |
|
| 12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
| 13 |
|
| 14 | <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
|
| 15 |
|
| 16 | </head>
|
| 17 |
|
| 18 | <body>
|
| 19 |
|
| 20 | <div class="navbar navbar-default navbar-fixed-top ">
|
| 21 | <div class="container">
|
| 22 | <div class="navbar-header">
|
| 23 | <a class="navbar-brand" href="index.html">Documentation</a>
|
| 24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
| 25 | <span class="icon-bar"></span>
|
| 26 | <span class="icon-bar"></span>
|
| 27 | <span class="icon-bar"></span>
|
| 28 | </button>
|
| 29 | </div>
|
| 30 | <div class="navbar-collapse collapse" id="topNavigation">
|
| 31 | <ul class="nav navbar-nav">
|
| 32 |
|
| 33 | <li class="dropdown">
|
| 34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
| 35 | <ul class="dropdown-menu ">
|
| 36 | <li><a href="faker.html">faker</a></li><li><a href="faker.address.html">faker.address</a></li><li><a href="faker.commerce.html">faker.commerce</a></li><li><a href="faker.company.html">faker.company</a></li><li><a href="faker.date.html">faker.date</a></li><li><a href="faker.finance.html">faker.finance</a></li><li><a href="faker.hacker.html">faker.hacker</a></li><li><a href="faker.helpers.html">faker.helpers</a></li><li><a href="faker.image.html">faker.image</a></li><li><a href="faker.internet.html">faker.internet</a></li><li><a href="faker.lorem.html">faker.lorem</a></li><li><a href="faker.name.html">faker.name</a></li><li><a href="faker.phone.html">faker.phone</a></li><li><a href="faker.random.html">faker.random</a></li><li><a href="faker.system.html">faker.system</a></li>
|
| 37 | </ul>
|
| 38 | </li>
|
| 39 |
|
| 40 | </ul>
|
| 41 | <div class="col-sm-3 col-md-3">
|
| 42 | <form class="navbar-form" role="search">
|
| 43 | <div class="input-group">
|
| 44 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
| 45 | <div class="input-group-btn">
|
| 46 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
| 47 | </div>
|
| 48 | </div>
|
| 49 | </form>
|
| 50 | </div>
|
| 51 | </div>
|
| 52 |
|
| 53 | </div>
|
| 54 | </div>
|
| 55 |
|
| 56 |
|
| 57 | <div class="container" id="toc-content">
|
| 58 | <div class="row">
|
| 59 |
|
| 60 |
|
| 61 | <div class="col-md-8">
|
| 62 |
|
| 63 | <div id="main">
|
| 64 |
|
| 65 |
|
| 66 | <h1 class="page-title">Namespace: date</h1>
|
| 67 | <section>
|
| 68 |
|
| 69 | <header>
|
| 70 |
|
| 71 | <h2>
|
| 72 | <span class="ancestors"><a href="faker.html">faker</a>.</span>
|
| 73 |
|
| 74 | date
|
| 75 | </h2>
|
| 76 |
|
| 77 |
|
| 78 | </header>
|
| 79 |
|
| 80 |
|
| 81 | <article>
|
| 82 | <div class="container-overview">
|
| 83 |
|
| 84 |
|
| 85 |
|
| 86 |
|
| 87 | <dl class="details">
|
| 88 |
|
| 89 |
|
| 90 |
|
| 91 |
|
| 92 |
|
| 93 |
|
| 94 |
|
| 95 |
|
| 96 |
|
| 97 |
|
| 98 |
|
| 99 |
|
| 100 |
|
| 101 |
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 | </dl>
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 | </div>
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
|
| 136 |
|
| 137 |
|
| 138 |
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 | <h3 class="subsection-title">Methods</h3>
|
| 144 |
|
| 145 | <dl>
|
| 146 |
|
| 147 | <hr>
|
| 148 | <dt>
|
| 149 | <h4 class="name" id=".between"><span class="type-signature"><static> </span>between(from, to)</h4>
|
| 150 |
|
| 151 |
|
| 152 | </dt>
|
| 153 | <dd>
|
| 154 |
|
| 155 |
|
| 156 | <div class="description">
|
| 157 | <p>between</p>
|
| 158 | </div>
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 |
|
| 166 |
|
| 167 | <h5>Parameters:</h5>
|
| 168 |
|
| 169 |
|
| 170 | <table class="params table table-striped">
|
| 171 | <thead>
|
| 172 | <tr>
|
| 173 |
|
| 174 | <th>Name</th>
|
| 175 |
|
| 176 |
|
| 177 | <th>Type</th>
|
| 178 |
|
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 | <th class="last">Description</th>
|
| 184 | </tr>
|
| 185 | </thead>
|
| 186 |
|
| 187 | <tbody>
|
| 188 |
|
| 189 |
|
| 190 | <tr>
|
| 191 |
|
| 192 | <td class="name"><code>from</code></td>
|
| 193 |
|
| 194 |
|
| 195 | <td class="type">
|
| 196 |
|
| 197 |
|
| 198 | <span class="param-type">date</span>
|
| 199 |
|
| 200 |
|
| 201 |
|
| 202 |
|
| 203 | </td>
|
| 204 |
|
| 205 |
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 | <td class="description last"></td>
|
| 210 | </tr>
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 | <tr>
|
| 215 |
|
| 216 | <td class="name"><code>to</code></td>
|
| 217 |
|
| 218 |
|
| 219 | <td class="type">
|
| 220 |
|
| 221 |
|
| 222 | <span class="param-type">date</span>
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 | </td>
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 | <td class="description last"></td>
|
| 234 | </tr>
|
| 235 |
|
| 236 |
|
| 237 | </tbody>
|
| 238 | </table>
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 | <dl class="details">
|
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 | </dl>
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 | </dd>
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 | <hr>
|
| 300 | <dt>
|
| 301 | <h4 class="name" id=".future"><span class="type-signature"><static> </span>future(years, refDate)</h4>
|
| 302 |
|
| 303 |
|
| 304 | </dt>
|
| 305 | <dd>
|
| 306 |
|
| 307 |
|
| 308 | <div class="description">
|
| 309 | <p>future</p>
|
| 310 | </div>
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 | <h5>Parameters:</h5>
|
| 320 |
|
| 321 |
|
| 322 | <table class="params table table-striped">
|
| 323 | <thead>
|
| 324 | <tr>
|
| 325 |
|
| 326 | <th>Name</th>
|
| 327 |
|
| 328 |
|
| 329 | <th>Type</th>
|
| 330 |
|
| 331 |
|
| 332 |
|
| 333 |
|
| 334 |
|
| 335 | <th class="last">Description</th>
|
| 336 | </tr>
|
| 337 | </thead>
|
| 338 |
|
| 339 | <tbody>
|
| 340 |
|
| 341 |
|
| 342 | <tr>
|
| 343 |
|
| 344 | <td class="name"><code>years</code></td>
|
| 345 |
|
| 346 |
|
| 347 | <td class="type">
|
| 348 |
|
| 349 |
|
| 350 | <span class="param-type">number</span>
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 | </td>
|
| 356 |
|
| 357 |
|
| 358 |
|
| 359 |
|
| 360 |
|
| 361 | <td class="description last"></td>
|
| 362 | </tr>
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 | <tr>
|
| 367 |
|
| 368 | <td class="name"><code>refDate</code></td>
|
| 369 |
|
| 370 |
|
| 371 | <td class="type">
|
| 372 |
|
| 373 |
|
| 374 | <span class="param-type">date</span>
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 | </td>
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 | <td class="description last"></td>
|
| 386 | </tr>
|
| 387 |
|
| 388 |
|
| 389 | </tbody>
|
| 390 | </table>
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 |
|
| 395 | <dl class="details">
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 |
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 |
|
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 |
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 |
|
| 426 |
|
| 427 |
|
| 428 |
|
| 429 |
|
| 430 |
|
| 431 | </dl>
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
|
| 445 |
|
| 446 |
|
| 447 | </dd>
|
| 448 |
|
| 449 |
|
| 450 |
|
| 451 | <hr>
|
| 452 | <dt>
|
| 453 | <h4 class="name" id=".month"><span class="type-signature"><static> </span>month(options)</h4>
|
| 454 |
|
| 455 |
|
| 456 | </dt>
|
| 457 | <dd>
|
| 458 |
|
| 459 |
|
| 460 | <div class="description">
|
| 461 | <p>month</p>
|
| 462 | </div>
|
| 463 |
|
| 464 |
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 |
|
| 469 |
|
| 470 |
|
| 471 | <h5>Parameters:</h5>
|
| 472 |
|
| 473 |
|
| 474 | <table class="params table table-striped">
|
| 475 | <thead>
|
| 476 | <tr>
|
| 477 |
|
| 478 | <th>Name</th>
|
| 479 |
|
| 480 |
|
| 481 | <th>Type</th>
|
| 482 |
|
| 483 |
|
| 484 |
|
| 485 |
|
| 486 |
|
| 487 | <th class="last">Description</th>
|
| 488 | </tr>
|
| 489 | </thead>
|
| 490 |
|
| 491 | <tbody>
|
| 492 |
|
| 493 |
|
| 494 | <tr>
|
| 495 |
|
| 496 | <td class="name"><code>options</code></td>
|
| 497 |
|
| 498 |
|
| 499 | <td class="type">
|
| 500 |
|
| 501 |
|
| 502 | <span class="param-type">object</span>
|
| 503 |
|
| 504 |
|
| 505 |
|
| 506 |
|
| 507 | </td>
|
| 508 |
|
| 509 |
|
| 510 |
|
| 511 |
|
| 512 |
|
| 513 | <td class="description last"></td>
|
| 514 | </tr>
|
| 515 |
|
| 516 |
|
| 517 | </tbody>
|
| 518 | </table>
|
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
|
| 523 | <dl class="details">
|
| 524 |
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 |
|
| 531 |
|
| 532 |
|
| 533 |
|
| 534 |
|
| 535 |
|
| 536 |
|
| 537 |
|
| 538 |
|
| 539 |
|
| 540 |
|
| 541 |
|
| 542 |
|
| 543 |
|
| 544 |
|
| 545 |
|
| 546 |
|
| 547 |
|
| 548 |
|
| 549 |
|
| 550 |
|
| 551 |
|
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 |
|
| 559 | </dl>
|
| 560 |
|
| 561 |
|
| 562 |
|
| 563 |
|
| 564 |
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 |
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 | </dd>
|
| 576 |
|
| 577 |
|
| 578 |
|
| 579 | <hr>
|
| 580 | <dt>
|
| 581 | <h4 class="name" id=".past"><span class="type-signature"><static> </span>past(years, refDate)</h4>
|
| 582 |
|
| 583 |
|
| 584 | </dt>
|
| 585 | <dd>
|
| 586 |
|
| 587 |
|
| 588 | <div class="description">
|
| 589 | <p>past</p>
|
| 590 | </div>
|
| 591 |
|
| 592 |
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 | <h5>Parameters:</h5>
|
| 600 |
|
| 601 |
|
| 602 | <table class="params table table-striped">
|
| 603 | <thead>
|
| 604 | <tr>
|
| 605 |
|
| 606 | <th>Name</th>
|
| 607 |
|
| 608 |
|
| 609 | <th>Type</th>
|
| 610 |
|
| 611 |
|
| 612 |
|
| 613 |
|
| 614 |
|
| 615 | <th class="last">Description</th>
|
| 616 | </tr>
|
| 617 | </thead>
|
| 618 |
|
| 619 | <tbody>
|
| 620 |
|
| 621 |
|
| 622 | <tr>
|
| 623 |
|
| 624 | <td class="name"><code>years</code></td>
|
| 625 |
|
| 626 |
|
| 627 | <td class="type">
|
| 628 |
|
| 629 |
|
| 630 | <span class="param-type">number</span>
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 | </td>
|
| 636 |
|
| 637 |
|
| 638 |
|
| 639 |
|
| 640 |
|
| 641 | <td class="description last"></td>
|
| 642 | </tr>
|
| 643 |
|
| 644 |
|
| 645 |
|
| 646 | <tr>
|
| 647 |
|
| 648 | <td class="name"><code>refDate</code></td>
|
| 649 |
|
| 650 |
|
| 651 | <td class="type">
|
| 652 |
|
| 653 |
|
| 654 | <span class="param-type">date</span>
|
| 655 |
|
| 656 |
|
| 657 |
|
| 658 |
|
| 659 | </td>
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 |
|
| 665 | <td class="description last"></td>
|
| 666 | </tr>
|
| 667 |
|
| 668 |
|
| 669 | </tbody>
|
| 670 | </table>
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 |
|
| 675 | <dl class="details">
|
| 676 |
|
| 677 |
|
| 678 |
|
| 679 |
|
| 680 |
|
| 681 |
|
| 682 |
|
| 683 |
|
| 684 |
|
| 685 |
|
| 686 |
|
| 687 |
|
| 688 |
|
| 689 |
|
| 690 |
|
| 691 |
|
| 692 |
|
| 693 |
|
| 694 |
|
| 695 |
|
| 696 |
|
| 697 |
|
| 698 |
|
| 699 |
|
| 700 |
|
| 701 |
|
| 702 |
|
| 703 |
|
| 704 |
|
| 705 |
|
| 706 |
|
| 707 |
|
| 708 |
|
| 709 |
|
| 710 |
|
| 711 | </dl>
|
| 712 |
|
| 713 |
|
| 714 |
|
| 715 |
|
| 716 |
|
| 717 |
|
| 718 |
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
|
| 725 |
|
| 726 |
|
| 727 | </dd>
|
| 728 |
|
| 729 |
|
| 730 |
|
| 731 | <hr>
|
| 732 | <dt>
|
| 733 | <h4 class="name" id=".recent"><span class="type-signature"><static> </span>recent(days)</h4>
|
| 734 |
|
| 735 |
|
| 736 | </dt>
|
| 737 | <dd>
|
| 738 |
|
| 739 |
|
| 740 | <div class="description">
|
| 741 | <p>recent</p>
|
| 742 | </div>
|
| 743 |
|
| 744 |
|
| 745 |
|
| 746 |
|
| 747 |
|
| 748 |
|
| 749 |
|
| 750 |
|
| 751 | <h5>Parameters:</h5>
|
| 752 |
|
| 753 |
|
| 754 | <table class="params table table-striped">
|
| 755 | <thead>
|
| 756 | <tr>
|
| 757 |
|
| 758 | <th>Name</th>
|
| 759 |
|
| 760 |
|
| 761 | <th>Type</th>
|
| 762 |
|
| 763 |
|
| 764 |
|
| 765 |
|
| 766 |
|
| 767 | <th class="last">Description</th>
|
| 768 | </tr>
|
| 769 | </thead>
|
| 770 |
|
| 771 | <tbody>
|
| 772 |
|
| 773 |
|
| 774 | <tr>
|
| 775 |
|
| 776 | <td class="name"><code>days</code></td>
|
| 777 |
|
| 778 |
|
| 779 | <td class="type">
|
| 780 |
|
| 781 |
|
| 782 | <span class="param-type">number</span>
|
| 783 |
|
| 784 |
|
| 785 |
|
| 786 |
|
| 787 | </td>
|
| 788 |
|
| 789 |
|
| 790 |
|
| 791 |
|
| 792 |
|
| 793 | <td class="description last"></td>
|
| 794 | </tr>
|
| 795 |
|
| 796 |
|
| 797 | </tbody>
|
| 798 | </table>
|
| 799 |
|
| 800 |
|
| 801 |
|
| 802 |
|
| 803 | <dl class="details">
|
| 804 |
|
| 805 |
|
| 806 |
|
| 807 |
|
| 808 |
|
| 809 |
|
| 810 |
|
| 811 |
|
| 812 |
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 |
|
| 818 |
|
| 819 |
|
| 820 |
|
| 821 |
|
| 822 |
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 |
|
| 827 |
|
| 828 |
|
| 829 |
|
| 830 |
|
| 831 |
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 |
|
| 837 |
|
| 838 |
|
| 839 | </dl>
|
| 840 |
|
| 841 |
|
| 842 |
|
| 843 |
|
| 844 |
|
| 845 |
|
| 846 |
|
| 847 |
|
| 848 |
|
| 849 |
|
| 850 |
|
| 851 |
|
| 852 |
|
| 853 |
|
| 854 |
|
| 855 | </dd>
|
| 856 |
|
| 857 |
|
| 858 |
|
| 859 | <hr>
|
| 860 | <dt>
|
| 861 | <h4 class="name" id=".weekday"><span class="type-signature"><static> </span>weekday(options)</h4>
|
| 862 |
|
| 863 |
|
| 864 | </dt>
|
| 865 | <dd>
|
| 866 |
|
| 867 |
|
| 868 | <div class="description">
|
| 869 | <p>weekday</p>
|
| 870 | </div>
|
| 871 |
|
| 872 |
|
| 873 |
|
| 874 |
|
| 875 |
|
| 876 |
|
| 877 |
|
| 878 |
|
| 879 | <h5>Parameters:</h5>
|
| 880 |
|
| 881 |
|
| 882 | <table class="params table table-striped">
|
| 883 | <thead>
|
| 884 | <tr>
|
| 885 |
|
| 886 | <th>Name</th>
|
| 887 |
|
| 888 |
|
| 889 | <th>Type</th>
|
| 890 |
|
| 891 |
|
| 892 |
|
| 893 |
|
| 894 |
|
| 895 | <th class="last">Description</th>
|
| 896 | </tr>
|
| 897 | </thead>
|
| 898 |
|
| 899 | <tbody>
|
| 900 |
|
| 901 |
|
| 902 | <tr>
|
| 903 |
|
| 904 | <td class="name"><code>options</code></td>
|
| 905 |
|
| 906 |
|
| 907 | <td class="type">
|
| 908 |
|
| 909 |
|
| 910 | <span class="param-type">object</span>
|
| 911 |
|
| 912 |
|
| 913 |
|
| 914 |
|
| 915 | </td>
|
| 916 |
|
| 917 |
|
| 918 |
|
| 919 |
|
| 920 |
|
| 921 | <td class="description last"></td>
|
| 922 | </tr>
|
| 923 |
|
| 924 |
|
| 925 | </tbody>
|
| 926 | </table>
|
| 927 |
|
| 928 |
|
| 929 |
|
| 930 |
|
| 931 | <dl class="details">
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 |
|
| 936 |
|
| 937 |
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
|
| 949 |
|
| 950 |
|
| 951 |
|
| 952 |
|
| 953 |
|
| 954 |
|
| 955 |
|
| 956 |
|
| 957 |
|
| 958 |
|
| 959 |
|
| 960 |
|
| 961 |
|
| 962 |
|
| 963 |
|
| 964 |
|
| 965 |
|
| 966 |
|
| 967 | </dl>
|
| 968 |
|
| 969 |
|
| 970 |
|
| 971 |
|
| 972 |
|
| 973 |
|
| 974 |
|
| 975 |
|
| 976 |
|
| 977 |
|
| 978 |
|
| 979 |
|
| 980 |
|
| 981 |
|
| 982 |
|
| 983 | </dd>
|
| 984 |
|
| 985 | </dl>
|
| 986 |
|
| 987 |
|
| 988 |
|
| 989 |
|
| 990 |
|
| 991 | </article>
|
| 992 |
|
| 993 | </section>
|
| 994 |
|
| 995 |
|
| 996 |
|
| 997 |
|
| 998 | </div>
|
| 999 | </div>
|
| 1000 |
|
| 1001 | <div class="clearfix"></div>
|
| 1002 |
|
| 1003 |
|
| 1004 | <div class="col-md-3">
|
| 1005 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
| 1006 | </div>
|
| 1007 |
|
| 1008 |
|
| 1009 | </div>
|
| 1010 | </div>
|
| 1011 |
|
| 1012 | <div class="modal fade" id="searchResults">
|
| 1013 | <div class="modal-dialog">
|
| 1014 | <div class="modal-content">
|
| 1015 | <div class="modal-header">
|
| 1016 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
| 1017 | <h4 class="modal-title">Search results</h4>
|
| 1018 | </div>
|
| 1019 | <div class="modal-body"></div>
|
| 1020 | <div class="modal-footer">
|
| 1021 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
| 1022 | </div>
|
| 1023 | </div>
|
| 1024 | </div>
|
| 1025 | </div>
|
| 1026 |
|
| 1027 | <footer>
|
| 1028 |
|
| 1029 |
|
| 1030 | <span class="jsdoc-message">
|
| 1031 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
|
| 1032 |
|
| 1033 | on 2016-03-19T23:15:39-04:00
|
| 1034 |
|
| 1035 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
| 1036 | </span>
|
| 1037 | </footer>
|
| 1038 |
|
| 1039 | <script src="scripts/docstrap.lib.js"></script>
|
| 1040 | <script src="scripts/toc.js"></script>
|
| 1041 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
| 1042 |
|
| 1043 | <script>
|
| 1044 | $( function () {
|
| 1045 | $( "[id*='$']" ).each( function () {
|
| 1046 | var $this = $( this );
|
| 1047 |
|
| 1048 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
| 1049 | } );
|
| 1050 |
|
| 1051 | $( ".tutorial-section pre, .readme-section pre" ).each( function () {
|
| 1052 | var $this = $( this );
|
| 1053 |
|
| 1054 | var example = $this.find( "code" );
|
| 1055 | exampleText = example.html();
|
| 1056 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
| 1057 | if ( lang && lang[1] ) {
|
| 1058 | exampleText = exampleText.replace( lang[0], "" );
|
| 1059 | example.html( exampleText );
|
| 1060 | lang = lang[1];
|
| 1061 | } else {
|
| 1062 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
| 1063 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
| 1064 | }
|
| 1065 |
|
| 1066 | if ( lang ) {
|
| 1067 |
|
| 1068 | $this
|
| 1069 | .addClass( "sunlight-highlight-" + lang )
|
| 1070 | .addClass( "linenums" )
|
| 1071 | .html( example.html() );
|
| 1072 |
|
| 1073 | }
|
| 1074 | } );
|
| 1075 |
|
| 1076 | Sunlight.highlightAll( {
|
| 1077 | lineNumbers : false,
|
| 1078 | showMenu : true,
|
| 1079 | enableDoclinks : true
|
| 1080 | } );
|
| 1081 |
|
| 1082 | $.catchAnchorLinks( {
|
| 1083 | navbarOffset: 10
|
| 1084 | } );
|
| 1085 | $( "#toc" ).toc( {
|
| 1086 | anchorName : function ( i, heading, prefix ) {
|
| 1087 | var id = $( heading ).attr( "id" );
|
| 1088 | return id && id.replace(/\~/g, '-inner-').replace(/\./g, '-static-') || ( prefix + i );
|
| 1089 | },
|
| 1090 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
| 1091 | showAndHide : false,
|
| 1092 | smoothScrolling: true
|
| 1093 | } );
|
| 1094 |
|
| 1095 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
| 1096 | $( '.dropdown-toggle' ).dropdown();
|
| 1097 |
|
| 1098 | $( "table" ).each( function () {
|
| 1099 | var $this = $( this );
|
| 1100 | $this.addClass('table');
|
| 1101 | } );
|
| 1102 |
|
| 1103 | } );
|
| 1104 | </script>
|
| 1105 |
|
| 1106 |
|
| 1107 |
|
| 1108 |
|
| 1109 |
|
| 1110 |
|
| 1111 |
|
| 1112 |
|
| 1113 |
|
| 1114 | <script type="text/javascript">
|
| 1115 | $(document).ready(function() {
|
| 1116 | SearcherDisplay.init();
|
| 1117 | });
|
| 1118 | </script>
|
| 1119 |
|
| 1120 | </body>
|
| 1121 | </html> |
| \ | No newline at end of file |