1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

test,doc: wrap common module md doc at 80 chars

Browse Source 
In preparation for markdown linting of files in the `test` directory,
make sure all lines in `test/common/README.md` are no more than 80
characters long.

PR-URL: https://github.com/nodejs/node/pull/22221
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
This commit is contained in:
Rich Trott 2018-08-09 15:10:47 -07:00
parent 73cb7fb7ae
commit 9fbd2af655
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
test/common/README.md
View File

@ -572,7 +572,7 @@ one listed below. (`heap.validateSnapshotNodes(...)` is a shortcut for
Create a heap dump and an embedder graph copy and validate occurrences. Create a heap dump and an embedder graph copy and validate occurrences.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
validateSnapshotNodes('TLSWRAP', [ validateSnapshotNodes('TLSWRAP', [
{ {
@ -590,7 +590,7 @@ validateSnapshotNodes('TLSWRAP', [
The http2.js module provides a handful of utilities for creating mock HTTP/2 The http2.js module provides a handful of utilities for creating mock HTTP/2
frames for testing of HTTP/2 endpoints frames for testing of HTTP/2 endpoints
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-unused-vars, node-core/required-modules -->
```js ```js
const http2 = require('../common/http2'); const http2 = require('../common/http2');
``` ```
@ -600,7 +600,7 @@ const http2 = require('../common/http2');
The `http2.Frame` is a base class that creates a `Buffer` containing a The `http2.Frame` is a base class that creates a `Buffer` containing a
serialized HTTP/2 frame header. serialized HTTP/2 frame header.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
// length is a 24-bit unsigned integer // length is a 24-bit unsigned integer
// type is an 8-bit unsigned integer identifying the frame type // type is an 8-bit unsigned integer identifying the frame type
@ -619,7 +619,7 @@ The serialized `Buffer` may be retrieved using the `frame.data` property.
The `http2.DataFrame` is a subclass of `http2.Frame` that serializes a `DATA` The `http2.DataFrame` is a subclass of `http2.Frame` that serializes a `DATA`
frame. frame.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
// id is the 32-bit stream identifier // id is the 32-bit stream identifier
// payload is a Buffer containing the DATA payload // payload is a Buffer containing the DATA payload
@ -636,7 +636,7 @@ socket.write(frame.data);
The `http2.HeadersFrame` is a subclass of `http2.Frame` that serializes a The `http2.HeadersFrame` is a subclass of `http2.Frame` that serializes a
`HEADERS` frame. `HEADERS` frame.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
// id is the 32-bit stream identifier // id is the 32-bit stream identifier
// payload is a Buffer containing the HEADERS payload (see either // payload is a Buffer containing the HEADERS payload (see either
@ -654,7 +654,7 @@ socket.write(frame.data);
The `http2.SettingsFrame` is a subclass of `http2.Frame` that serializes an The `http2.SettingsFrame` is a subclass of `http2.Frame` that serializes an
empty `SETTINGS` frame. empty `SETTINGS` frame.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
// ack is a boolean indicating whether or not to set the ACK flag. // ack is a boolean indicating whether or not to set the ACK flag.
const frame = new http2.SettingsFrame(ack); const frame = new http2.SettingsFrame(ack);
@ -667,7 +667,7 @@ socket.write(frame.data);
Set to a `Buffer` instance that contains a minimal set of serialized HTTP/2 Set to a `Buffer` instance that contains a minimal set of serialized HTTP/2
request headers to be used as the payload of a `http2.HeadersFrame`. request headers to be used as the payload of a `http2.HeadersFrame`.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
const frame = new http2.HeadersFrame(1, http2.kFakeRequestHeaders, 0, true); const frame = new http2.HeadersFrame(1, http2.kFakeRequestHeaders, 0, true);
@ -679,7 +679,7 @@ socket.write(frame.data);
Set to a `Buffer` instance that contains a minimal set of serialized HTTP/2 Set to a `Buffer` instance that contains a minimal set of serialized HTTP/2
response headers to be used as the payload a `http2.HeadersFrame`. response headers to be used as the payload a `http2.HeadersFrame`.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
const frame = new http2.HeadersFrame(1, http2.kFakeResponseHeaders, 0, true); const frame = new http2.HeadersFrame(1, http2.kFakeResponseHeaders, 0, true);
@ -691,7 +691,7 @@ socket.write(frame.data);
Set to a `Buffer` containing the preamble bytes an HTTP/2 client must send Set to a `Buffer` containing the preamble bytes an HTTP/2 client must send
upon initial establishment of a connection. upon initial establishment of a connection.
<!-- eslint-disable no-undef, no-unused-vars, node-core/required-modules, strict --> <!-- eslint-disable no-undef, node-core/required-modules -->
```js ```js
socket.write(http2.kClientMagic); socket.write(http2.kClientMagic);
``` ```