Create method to spawn namespaced loggers

1 files changed, 21 insertions, 0 deletions

diff --git a/packages/server/src/helpers/logging.ts b/packages/server/src/helpers/logging.ts
new file mode 100644
index 0000000..2a8b67e
--- /dev/null
+++ b/packages/server/src/helpers/logging.ts
@@ -0,0 +1,21 @@
+import debug, { Debugger } from 'debug';
+
+const defaultLogger = debug('SimpleWebAuthn');
+
+/**
+ * Generate an instance of a `debug` logger that extends off of the "simplewebauthn" namespace for
+ * consistent naming.
+ *
+ * See https://www.npmjs.com/package/debug for information on how to control logging output when
+ * using @simplewebauthn/server
+ *
+ * Example:
+ *
+ * ```
+ * const log = getLogger('mds');
+ * log('hello'); // simplewebauthn:mds hello +0ms
+ * ```
+ */
+export function getLogger(name: string): Debugger {
+  return defaultLogger.extend(name);
+}