docs: add jsdoc

Author: sxzz

src/browser.ts

@@ -223,6 +223,10 @@ function save(namespaces: string) {
   }
 }
 
+/**
+ * Enables a debug mode by namespaces. This can include modes
+ * separated by a colon and wildcards.
+ */
 function enable(namespaces: string): void {
   save(namespaces)
   _enable(namespaces)

src/core.ts

@@ -3,6 +3,9 @@ import type { Debugger, DebugOptions } from './types.ts'
 
 let globalNamespaces: string = ''
 
+/**
+ * Returns a string of the currently enabled debug namespaces.
+ */
 export function namespaces(): string {
   return globalNamespaces
 }
@@ -127,6 +130,9 @@ export function enable(namespaces: string): void {
   }
 }
 
+/**
+ * Disable debug output.
+ */
 export function disable(): string {
   const namespaces = [
     ...names,
@@ -136,6 +142,9 @@ export function disable(): string {
   return namespaces
 }
 
+/**
+ * Returns true if the given mode name is enabled, false otherwise.
+ */
 export function enabled(name: string): boolean {
   for (const skip of skips) {
     if (matchesTemplate(name, skip)) {

src/node.ts

@@ -80,7 +80,7 @@ function getDate(): string {
 /**
  * Adds ANSI color escape codes if enabled.
  */
-export function formatArgs(
+function formatArgs(
   this: Debugger,
   diff: number,
   args: [string, ...any[]],
@@ -153,6 +153,10 @@ function save(namespaces: string): void {
   }
 }
 
+/**
+ * Enables a debug mode by namespaces. This can include modes
+ * separated by a colon and wildcards.
+ */
 function enable(namespaces: string): void {
   save(namespaces)
   _enable(namespaces)

src/types.ts

@@ -4,6 +4,11 @@ export interface InspectOptions extends NodeInspectOptions {
   hideDate?: boolean
 }
 
+/**
+ * Map of special "%n" handling functions, for the debug "format" argument.
+ *
+ * Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
+ */
 export interface Formatters {
   [formatter: string]: (this: Debugger, v: any) => string
 }