From e6b3cb36665b51c5b7cc88f13513bf71c36a4f3a Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Tue, 25 Feb 2025 17:52:54 -0500 Subject: [PATCH] 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. --- doc/contributors/extensions/events.json.js | 29 +++++++++++++++++++--- doc/contributors/extensions/gen.js | 14 ++++++++--- package-lock.json | 1 + package.json | 1 + 4 files changed, 39 insertions(+), 6 deletions(-) diff --git a/doc/contributors/extensions/events.json.js b/doc/contributors/extensions/events.json.js index 55cf9197..b0a83501 100644 --- a/doc/contributors/extensions/events.json.js +++ b/doc/contributors/extensions/events.json.js @@ -1,4 +1,4 @@ -module.exports = [ +export default [ { id: 'core.email.validate', description: ` @@ -23,5 +23,28 @@ module.exports = [ ] }, }, - } -]; \ No newline at end of file + }, + { + id: 'core.request.measured', + description: ` + This event is emitted when a requests incoming and outgoing bytes + have been measured. + `, + example: { + language: 'javascript', + code: /*javascript*/` + extension.on('core.request.measured', data => { + const measurements = data.measurements; + // measurements = { sz_incoming: integer, sz_outgoing: integer } + + const actor = data.actor; // instance of Actor + + console.log('\\x1B[36;1m === MEASUREMENT ===\\x1B[0m\\n', { + actor: data.actor.uid, + measurements: data.measurements + }); + }); + ` + } + }, +]; diff --git a/doc/contributors/extensions/gen.js b/doc/contributors/extensions/gen.js index d0963794..517b565b 100644 --- a/doc/contributors/extensions/gen.js +++ b/doc/contributors/extensions/gen.js @@ -1,5 +1,5 @@ -const dedent = require('dedent'); -const events = require('./events.json.js'); +import dedent from 'dedent'; +import events from './events.json.js'; const mdlib = {}; mdlib.h = (out, n, str) => { @@ -20,11 +20,19 @@ for ( const event of events ) { out(`- **Type**: ${prop.type}\n`); out(`- **Mutability**: ${prop.mutability}\n`); if ( prop.notes ) { - out(`- **Notes**: ${prop.n}\n`); + out(`- **Notes**:\n`); for ( const note of prop.notes ) { out(` - ${note}\n`); } } + out('\n'); } + if ( event.example ) { + mdlib.h(out, N_START + 1, `Example`); + out(`\`\`\`${event.example.language}\n${dedent(event.example.code)}\n\`\`\`\n`); + } + + out('\n'); + } diff --git a/package-lock.json b/package-lock.json index 78fef71d..67b31e4b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,6 +14,7 @@ "experiments/js-parse-and-output" ], "dependencies": { + "dedent": "^1.5.3", "javascript-time-ago": "^2.5.11", "json-colorizer": "^3.0.1", "open": "^10.1.0", diff --git a/package.json b/package.json index 4d784e64..6ccee391 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,7 @@ ] }, "dependencies": { + "dedent": "^1.5.3", "javascript-time-ago": "^2.5.11", "json-colorizer": "^3.0.1", "open": "^10.1.0",