Skip to content

doc: fix nits in common/README #17971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vsemozhetbyt wants to merge 3 commits into from
Closed

doc: fix nits in common/README #17971

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
398ebaf
doc: compact eslint directives in common/README
vsemozhetbyt Jan 4, 2018
f1dfe1b
doc: fix code nits in common/README
vsemozhetbyt Jan 4, 2018
d65c3ea
doc: re-alphabetise sections in common/README.md
vsemozhetbyt Jan 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc: re-alphabetise sections in common/README.md
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Jan 4, 2018
commit d65c3ea37762bce9ecf74e10fc98054fe79bb8d6
88 changes: 44 additions & 44 deletions test/common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This directory contains modules used to test the Node.js implementation.
* [DNS module](#dns-module)
* [Duplex pair helper](#duplex-pair-helper)
* [Fixtures module](#fixtures-module)
* [HTTP2 module](#http2-module)
* [Internet module](#internet-module)
* [WPT module](#wpt-module)
* [HTTP2 module](#http2-module)

## Benchmark Module

Expand Down Expand Up @@ -509,49 +509,6 @@ Returns the result of
Returns the result of
`fs.readFileSync(path.join(fixtures.fixturesDir, 'keys', arg), 'enc')`.

## Internet Module

The `common/internet` module provides utilities for working with
internet-related tests.

### internet.addresses

* [<Object>]
* `INET_HOST` [<String>] A generic host that has registered common
DNS records, supports both IPv4 and IPv6, and provides basic HTTP/HTTPS
services
* `INET4_HOST` [<String>] A host that provides IPv4 services
* `INET6_HOST` [<String>] A host that provides IPv6 services
* `INET4_IP` [<String>] An accessible IPv4 IP, defaults to the
Google Public DNS IPv4 address
* `INET6_IP` [<String>] An accessible IPv6 IP, defaults to the
Google Public DNS IPv6 address
* `INVALID_HOST` [<String>] An invalid host that cannot be resolved
* `MX_HOST` [<String>] A host with MX records registered
* `SRV_HOST` [<String>] A host with SRV records registered
* `PTR_HOST` [<String>] A host with PTR records registered
* `NAPTR_HOST` [<String>] A host with NAPTR records registered
* `SOA_HOST` [<String>] A host with SOA records registered
* `CNAME_HOST` [<String>] A host with CNAME records registered
* `NS_HOST` [<String>] A host with NS records registered
* `TXT_HOST` [<String>] A host with TXT records registered
* `DNS4_SERVER` [<String>] An accessible IPv4 DNS server
* `DNS6_SERVER` [<String>] An accessible IPv6 DNS server

A set of addresses for internet-related tests. All properties are configurable
via `NODE_TEST_*` environment variables. For example, to configure
`internet.addresses.INET_HOST`, set the environment
vairable `NODE_TEST_INET_HOST` to a specified host.

## WPT Module

The wpt.js module is a port of parts of
[W3C testharness.js](https://github.com/w3c/testharness.js) for testing the
Node.js
[WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api)
implementation with tests from
[W3C Web Platform Tests](https://github.com/w3c/web-platform-tests).

## HTTP/2 Module

The http2.js module provides a handful of utilities for creating mock HTTP/2
Expand Down Expand Up @@ -663,6 +620,49 @@ upon initial establishment of a connection.
socket.write(http2.kClientMagic);
```

## Internet Module

The `common/internet` module provides utilities for working with
internet-related tests.

### internet.addresses

* [<Object>]
* `INET_HOST` [<String>] A generic host that has registered common
DNS records, supports both IPv4 and IPv6, and provides basic HTTP/HTTPS
services
* `INET4_HOST` [<String>] A host that provides IPv4 services
* `INET6_HOST` [<String>] A host that provides IPv6 services
* `INET4_IP` [<String>] An accessible IPv4 IP, defaults to the
Google Public DNS IPv4 address
* `INET6_IP` [<String>] An accessible IPv6 IP, defaults to the
Google Public DNS IPv6 address
* `INVALID_HOST` [<String>] An invalid host that cannot be resolved
* `MX_HOST` [<String>] A host with MX records registered
* `SRV_HOST` [<String>] A host with SRV records registered
* `PTR_HOST` [<String>] A host with PTR records registered
* `NAPTR_HOST` [<String>] A host with NAPTR records registered
* `SOA_HOST` [<String>] A host with SOA records registered
* `CNAME_HOST` [<String>] A host with CNAME records registered
* `NS_HOST` [<String>] A host with NS records registered
* `TXT_HOST` [<String>] A host with TXT records registered
* `DNS4_SERVER` [<String>] An accessible IPv4 DNS server
* `DNS6_SERVER` [<String>] An accessible IPv6 DNS server

A set of addresses for internet-related tests. All properties are configurable
via `NODE_TEST_*` environment variables. For example, to configure
`internet.addresses.INET_HOST`, set the environment
vairable `NODE_TEST_INET_HOST` to a specified host.

## WPT Module

The wpt.js module is a port of parts of
[W3C testharness.js](https://github.com/w3c/testharness.js) for testing the
Node.js
[WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api)
implementation with tests from
[W3C Web Platform Tests](https://github.com/w3c/web-platform-tests).


[<Array>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[<ArrayBufferView[]>]: https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView
Expand Down