Document ParameterError

api/.gitignore

@@ -3,6 +3,7 @@ docs/*.md
 
 # subsequent PRs will un-ignore areas that are under review until
 # all docs are complete and we can drop this ignore file entirely
+!docs/tough-cookie.parametererror.md
 !docs/tough-cookie.permutepath.md
 !docs/tough-cookie.version.md
 !docs/tough-cookie.parsedate.md

api/docs/tough-cookie.parametererror.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [ParameterError](./tough-cookie.parametererror.md)
+
+## ParameterError class
+
+Represents a validation error.
+
+**Signature:**
+
+```typescript
+export declare class ParameterError extends Error 
+```
+**Extends:** Error
+

api/tough-cookie.api.md

@@ -263,7 +263,7 @@ export class MemoryCookieStore extends Store {
     updateCookie(oldCookie: Cookie, newCookie: Cookie, callback: ErrorCallback): void;
 }
 
-// @public (undocumented)
+// @public
 export class ParameterError extends Error {
 }
 

lib/validators.ts

@@ -83,4 +83,8 @@ export function validate(
   else throw err
 }
 
+/**
+ * Represents a validation error.
+ * @public
+ */
 export class ParameterError extends Error {}