diff options
| author | cjihrig <cjihrig@gmail.com> | 2021-02-15 21:21:50 +0300 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2021-02-17 18:12:01 +0300 |
| commit | d345ac901caf374d0c5321dab5f72d4bfb3581b4 (patch) | |
| tree | fe1cf361865db6bd939947695dd85e563f562c54 /doc/api/net.md | |
| parent | bd4d9ef637f8ead4668f21181d0d781cf769fca8 (diff) | |
doc: use **Default:** more consistently
It seems that **Default:** was unofficially decided on as
the way to specify default values. This commit updates the API
documentation to use this format more consistently.
PR-URL: https://github.com/nodejs/node/pull/37387
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index fd7de2512cd..231dde85428 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -70,7 +70,7 @@ added: v15.0.0 --> * `address` {string} An IPv4 or IPv6 address. -* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default**: `'ipv4'`. +* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default:** `'ipv4'`. Adds a rule to block the given IP address. @@ -81,7 +81,7 @@ added: v15.0.0 * `start` {string} The starting IPv4 or IPv6 address in the range. * `end` {string} The ending IPv4 or IPv6 address in the range. -* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default**: `'ipv4'`. +* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default:** `'ipv4'`. Adds a rule to block a range of IP addresses from `start` (inclusive) to `end` (inclusive). @@ -95,7 +95,7 @@ added: v15.0.0 * `prefix` {number} The number of CIDR prefix bits. For IPv4, this must be a value between `0` and `32`. For IPv6, this must be between `0` and `128`. -* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default**: `'ipv4'`. +* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default:** `'ipv4'`. Adds a rule to block a range of IP addresses specified as a subnet mask. @@ -105,7 +105,7 @@ added: v15.0.0 --> * `address` {string} The IP address to check -* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default**: `'ipv4'`. +* `type` {string} Either `'ipv4'` or `'ipv6'`. **Default:** `'ipv4'`. * Returns: {boolean} Returns `true` if the given IP address matches any of the rules added to the |