FormidableLabs#64 More docs

src/interceptor.ts

@@ -52,10 +52,25 @@ export interface IInterceptEvent {
   requestSerializer: RequestSerializer;
 }
 
+/**
+ * Configure intercept
+ */
 export interface IInterceptOptions {
+  /**
+   * Do not intercept outbound requests on these ports.
+   *
+   * By default MITM will intercept activity on any socket, HTTP or otherwise.
+   * If you need to ignore a port (eg for a database connection), provide that port number here.
+   *
+   * In practice YesNo normally runs after long running connections have been established,
+   * so this won't be a problem.
+   */
   ignorePorts?: number[];
 }
 
+/**
+ * Emit whenever we have proxied a request to its original destination
+ */
 export interface IProxiedEvent {
   requestSerializer: RequestSerializer;
   responseSerializer: ResponseSerializer;

src/mock-response.ts

@@ -16,6 +16,9 @@ import { RecordMode as Mode } from './recording';
 
 const debug: IDebugger = require('debug')('yesno:mock-response');
 
+/**
+ * Encapsulates logic for sending a response for an intercepted HTTP request
+ */
 export default class MockResponse {
   private event: IInterceptEvent;
   private ctx: Context;
@@ -25,6 +28,14 @@ export default class MockResponse {
     this.event = event;
   }
 
+  /**
+   * Send a respond for our wrapped intercept event if able.
+   *
+   * Give precedence to matching responses in shared context (from `yesno.matching().respond()`).
+   * Else, if we're in mock mode, lookup the mock response.
+   *
+   * @returns The received request & sent response. Returns `undefined` if unable to respond
+   */
   public async send(): Promise<ISeralizedRequestResponse | undefined> {
     const {
       interceptedRequest,

src/yesno.ts

@@ -37,7 +37,14 @@ export interface IRecordableTest {
   dir: string;
 }
 
+/**
+ * Options to configure intercept of HTTP requests
+ */
 export interface IYesNoInterceptingOptions extends IInterceptOptions {
+  /**
+   * Comparator function used to determine whether an intercepted request
+   * matches a loaded mock.
+   */
   comparatorFn?: ComparatorFn;
 }