Commit e9de5a9
doc: re-alphabetise sections in common/README.md
Backport-PR-URL: #20456
PR-URL: #17971
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent c924adf commit e9de5a9
1 file changed
Lines changed: 44 additions & 57 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -10,10 +10,10 @@ This directory contains modules used to test the Node.js implementation. | |||
| 10 | 10 | * [DNS module](#dns-module) | |
| 11 | 11 | * [Duplex pair helper](#duplex-pair-helper) | |
| 12 | 12 | * [Fixtures module](#fixtures-module) | |
| 13 | + * [HTTP2 module](#http2-module) | ||
| 13 | 14 | * [Internet module](#internet-module) | |
| 14 | 15 | * [tmpdir module](#tmpdir-module) | |
| 15 | 16 | * [WPT module](#wpt-module) | |
| 16 | - * [HTTP2 module](#http2-module) | ||
| 17 | 17 | ||
| 18 | 18 | ## Benchmark Module | |
| 19 | 19 | ||
@@ -504,62 +504,6 @@ Returns the result of | |||
| 504 | 504 | Returns the result of | |
| 505 | 505 | `fs.readFileSync(path.join(fixtures.fixturesDir, 'keys', arg), 'enc')`. | |
| 506 | 506 | ||
| 507 | - ## Internet Module | ||
| 508 | - | ||
| 509 | - The `common/internet` module provides utilities for working with | ||
| 510 | - internet-related tests. | ||
| 511 | - | ||
| 512 | - ### internet.addresses | ||
| 513 | - | ||
| 514 | - * [<Object>] | ||
| 515 | - * `INET_HOST` [<String>] A generic host that has registered common | ||
| 516 | - DNS records, supports both IPv4 and IPv6, and provides basic HTTP/HTTPS | ||
| 517 | - services | ||
| 518 | - * `INET4_HOST` [<String>] A host that provides IPv4 services | ||
| 519 | - * `INET6_HOST` [<String>] A host that provides IPv6 services | ||
| 520 | - * `INET4_IP` [<String>] An accessible IPv4 IP, defaults to the | ||
| 521 | - Google Public DNS IPv4 address | ||
| 522 | - * `INET6_IP` [<String>] An accessible IPv6 IP, defaults to the | ||
| 523 | - Google Public DNS IPv6 address | ||
| 524 | - * `INVALID_HOST` [<String>] An invalid host that cannot be resolved | ||
| 525 | - * `MX_HOST` [<String>] A host with MX records registered | ||
| 526 | - * `SRV_HOST` [<String>] A host with SRV records registered | ||
| 527 | - * `PTR_HOST` [<String>] A host with PTR records registered | ||
| 528 | - * `NAPTR_HOST` [<String>] A host with NAPTR records registered | ||
| 529 | - * `SOA_HOST` [<String>] A host with SOA records registered | ||
| 530 | - * `CNAME_HOST` [<String>] A host with CNAME records registered | ||
| 531 | - * `NS_HOST` [<String>] A host with NS records registered | ||
| 532 | - * `TXT_HOST` [<String>] A host with TXT records registered | ||
| 533 | - * `DNS4_SERVER` [<String>] An accessible IPv4 DNS server | ||
| 534 | - * `DNS6_SERVER` [<String>] An accessible IPv6 DNS server | ||
| 535 | - | ||
| 536 | - A set of addresses for internet-related tests. All properties are configurable | ||
| 537 | - via `NODE_TEST_*` environment variables. For example, to configure | ||
| 538 | - `internet.addresses.INET_HOST`, set the environment | ||
| 539 | - vairable `NODE_TEST_INET_HOST` to a specified host. | ||
| 540 | - | ||
| 541 | - ## tmpdir Module | ||
| 542 | - | ||
| 543 | - The `tmpdir` module supports the use of a temporary directory for testing. | ||
| 544 | - | ||
| 545 | - ### path | ||
| 546 | - * [<String>] | ||
| 547 | - | ||
| 548 | - The realpath of the testing temporary directory. | ||
| 549 | - | ||
| 550 | - ### refresh() | ||
| 551 | - | ||
| 552 | - Deletes and recreates the testing temporary directory. | ||
| 553 | - | ||
| 554 | - ## WPT Module | ||
| 555 | - | ||
| 556 | - The wpt.js module is a port of parts of | ||
| 557 | - [W3C testharness.js](https://github.com/w3c/testharness.js) for testing the | ||
| 558 | - Node.js | ||
| 559 | - [WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api) | ||
| 560 | - implementation with tests from | ||
| 561 | - [W3C Web Platform Tests](https://github.com/w3c/web-platform-tests). | ||
| 562 | - | ||
| 563 | 507 | ## HTTP/2 Module | |
| 564 | 508 | ||
| 565 | 509 | The http2.js module provides a handful of utilities for creating mock HTTP/2 | |
@@ -695,6 +639,49 @@ upon initial establishment of a connection. | |||
| 695 | 639 | socket.write(http2.kClientMagic); | |
| 696 | 640 | ``` | |
| 697 | 641 | ||
| 642 | + ## Internet Module | ||
| 643 | + | ||
| 644 | + The `common/internet` module provides utilities for working with | ||
| 645 | + internet-related tests. | ||
| 646 | + | ||
| 647 | + ### internet.addresses | ||
| 648 | + | ||
| 649 | + * [<Object>] | ||
| 650 | + * `INET_HOST` [<String>] A generic host that has registered common | ||
| 651 | + DNS records, supports both IPv4 and IPv6, and provides basic HTTP/HTTPS | ||
| 652 | + services | ||
| 653 | + * `INET4_HOST` [<String>] A host that provides IPv4 services | ||
| 654 | + * `INET6_HOST` [<String>] A host that provides IPv6 services | ||
| 655 | + * `INET4_IP` [<String>] An accessible IPv4 IP, defaults to the | ||
| 656 | + Google Public DNS IPv4 address | ||
| 657 | + * `INET6_IP` [<String>] An accessible IPv6 IP, defaults to the | ||
| 658 | + Google Public DNS IPv6 address | ||
| 659 | + * `INVALID_HOST` [<String>] An invalid host that cannot be resolved | ||
| 660 | + * `MX_HOST` [<String>] A host with MX records registered | ||
| 661 | + * `SRV_HOST` [<String>] A host with SRV records registered | ||
| 662 | + * `PTR_HOST` [<String>] A host with PTR records registered | ||
| 663 | + * `NAPTR_HOST` [<String>] A host with NAPTR records registered | ||
| 664 | + * `SOA_HOST` [<String>] A host with SOA records registered | ||
| 665 | + * `CNAME_HOST` [<String>] A host with CNAME records registered | ||
| 666 | + * `NS_HOST` [<String>] A host with NS records registered | ||
| 667 | + * `TXT_HOST` [<String>] A host with TXT records registered | ||
| 668 | + * `DNS4_SERVER` [<String>] An accessible IPv4 DNS server | ||
| 669 | + * `DNS6_SERVER` [<String>] An accessible IPv6 DNS server | ||
| 670 | + | ||
| 671 | + A set of addresses for internet-related tests. All properties are configurable | ||
| 672 | + via `NODE_TEST_*` environment variables. For example, to configure | ||
| 673 | + `internet.addresses.INET_HOST`, set the environment | ||
| 674 | + vairable `NODE_TEST_INET_HOST` to a specified host. | ||
| 675 | + | ||
| 676 | + ## WPT Module | ||
| 677 | + | ||
| 678 | + The wpt.js module is a port of parts of | ||
| 679 | + [W3C testharness.js](https://github.com/w3c/testharness.js) for testing the | ||
| 680 | + Node.js | ||
| 681 | + [WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api) | ||
| 682 | + implementation with tests from | ||
| 683 | + [W3C Web Platform Tests](https://github.com/w3c/web-platform-tests). | ||
| 684 | + | ||
| 698 | 685 | ||
| 699 | 686 | [<Array>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array | |
| 700 | 687 | [<ArrayBufferView[]>]: https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView | |
0 commit comments