disclaimer
FULL_NOTICE
const FULL_NOTICE: "ℹ GraphQL-Markdown collects anonymous usage data to help improve the tool.\n Sent: package/Node versions, OS, schema loader type, the settings you use,\n and the page count, duration and error type of each run.\n Custom strings, URLs and paths are masked; schema content is never sent.\n Details: https://graphql-markdown.dev/docs/telemetry\n Opt out: `gqlmd telemetry disable` or DO_NOT_TRACK=1\n";
Defined in: disclaimer.ts:5
isNoticeDue()
function isNoticeDue(state, ci?): boolean;
Defined in: disclaimer.ts:17
Whether the full notice is due (never in CI, where it is not recorded).
Parameters
state
TelemetryState | null | undefined
ci?
CiInfo = ...
Returns
boolean
printDisclaimer()
function printDisclaimer(state, ci, onFullNotice?): boolean;
Defined in: disclaimer.ts:39
Writes the notice straight to stderr, bypassing the logger, at most once per process.
When onFullNotice is given, the full notice is passed to it instead.
Parameters
state
TelemetryState | null | undefined
ci
onFullNotice?
(notice) => void
Returns
boolean
true when the full notice is due, shown now or earlier in this
process (it must then be recorded before anything is sent).
resetDisclaimer()
function resetDisclaimer(): void;
Defined in: disclaimer.ts:27
Internal
Resets the once-per-process guard.
Returns
void