Link to getLocal/getRemote methods within relevant JSDoc

httptoolkit · Feb 24, 2023 · 1004117 · 1004117
1 parent a9509b3
commit 1004117
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/mockttp.ts b/src/mockttp.ts
@@ -29,7 +29,8 @@ export type PortRange = { startPort: number, endPort: number };
 /**
  * A mockttp instance allow you to start and stop mock servers and control their behaviour.
  *
- * This should be created using the exported `getLocal()` or `getRemote()` methods, like:
+ * This should be created using the exported {@link getLocal} or {@link getRemote} methods, like
+ * so:
  *
  * ```
  * const mockServer = require('mockttp').getLocal()