docs(Agent Configuration): Add typedoc notes

Author: cblanc

lib/agent.ts

@@ -15,6 +15,12 @@ interface StringMap {
   [key: string]: string;
 }
 
+/**
+ * GotConfig
+ *
+ * An optional configuration object which is passed to the underlying got http
+ * client
+ */
 export type GotConfig = Partial<GotJSONOptions>;
 
 // Converts a Got header object to one that can be used by the client

lib/client.ts

@@ -16,6 +16,14 @@ interface Config extends Partial<CoreConfig> {
 }
 
 export class Client extends CoreInterface {
+  /**
+   * Client constructor extends CoreInterface by also accepting an optional got
+   * configuration object as the second argument.
+   *
+   * got is the underlying HTTP client that powers core-node. Be careful when
+   * configuring gotConfig so as not to manually override critical request
+   * attributes like method, query, header, etc.
+   */
   constructor(config: Config, gotConfig: GotConfig = {}) {
     const agent = new Agent(gotConfig);
     const header = { "User-Agent": userAgent };