Skip to content

Commit e6b3cb3

Browse files
committed
fix: get event docs back in sync
I used 'fix' for this instead of 'doc' because I am also adding a package for code that generates markdown, so this doesn't have the zero-risk nature typically associated with a "doc: " commit.
1 parent 04f9225 commit e6b3cb3

File tree

4 files changed

+39
-6
lines changed

4 files changed

+39
-6
lines changed

doc/contributors/extensions/events.json.js

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module.exports = [
1+
export default [
22
{
33
id: 'core.email.validate',
44
description: `
@@ -23,5 +23,28 @@ module.exports = [
2323
]
2424
},
2525
},
26-
}
27-
];
26+
},
27+
{
28+
id: 'core.request.measured',
29+
description: `
30+
This event is emitted when a requests incoming and outgoing bytes
31+
have been measured.
32+
`,
33+
example: {
34+
language: 'javascript',
35+
code: /*javascript*/`
36+
extension.on('core.request.measured', data => {
37+
const measurements = data.measurements;
38+
// measurements = { sz_incoming: integer, sz_outgoing: integer }
39+
40+
const actor = data.actor; // instance of Actor
41+
42+
console.log('\\x1B[36;1m === MEASUREMENT ===\\x1B[0m\\n', {
43+
actor: data.actor.uid,
44+
measurements: data.measurements
45+
});
46+
});
47+
`
48+
}
49+
},
50+
];

doc/contributors/extensions/gen.js

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
const dedent = require('dedent');
2-
const events = require('./events.json.js');
1+
import dedent from 'dedent';
2+
import events from './events.json.js';
33

44
const mdlib = {};
55
mdlib.h = (out, n, str) => {
@@ -20,11 +20,19 @@ for ( const event of events ) {
2020
out(`- **Type**: ${prop.type}\n`);
2121
out(`- **Mutability**: ${prop.mutability}\n`);
2222
if ( prop.notes ) {
23-
out(`- **Notes**: ${prop.n}\n`);
23+
out(`- **Notes**:\n`);
2424
for ( const note of prop.notes ) {
2525
out(` - ${note}\n`);
2626
}
2727
}
28+
out('\n');
2829
}
2930

31+
if ( event.example ) {
32+
mdlib.h(out, N_START + 1, `Example`);
33+
out(`\`\`\`${event.example.language}\n${dedent(event.example.code)}\n\`\`\`\n`);
34+
}
35+
36+
out('\n');
37+
3038
}

package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
]
4848
},
4949
"dependencies": {
50+
"dedent": "^1.5.3",
5051
"javascript-time-ago": "^2.5.11",
5152
"json-colorizer": "^3.0.1",
5253
"open": "^10.1.0",

0 commit comments

Comments
 (0)