diff --git a/api/.gitignore b/api/.gitignore index 674ab667..6651d7f1 100644 --- a/api/.gitignore +++ b/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 diff --git a/api/docs/tough-cookie.parametererror.md b/api/docs/tough-cookie.parametererror.md new file mode 100644 index 00000000..12f3e01e --- /dev/null +++ b/api/docs/tough-cookie.parametererror.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [ParameterError](./tough-cookie.parametererror.md) + +## ParameterError class + +Represents a validation error. + +**Signature:** + +```typescript +export declare class ParameterError extends Error +``` +**Extends:** Error + diff --git a/api/tough-cookie.api.md b/api/tough-cookie.api.md index 032dc9e1..77725730 100644 --- a/api/tough-cookie.api.md +++ b/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 { } diff --git a/lib/validators.ts b/lib/validators.ts index 64754973..ee98b9b8 100644 --- a/lib/validators.ts +++ b/lib/validators.ts @@ -83,4 +83,8 @@ export function validate( else throw err } +/** + * Represents a validation error. + * @public + */ export class ParameterError extends Error {}