Document formatDate

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.formatdate.md
 !docs/tough-cookie.domainmatch.md
 !docs/tough-cookie.defaultpath.md
 !docs/tough-cookie.cookiecompare.md

api/docs/tough-cookie.formatdate.md

@@ -0,0 +1,60 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [formatDate](./tough-cookie.formatdate.md)
+
+## formatDate() function
+
+Format a [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) into the [preferred Internet standard format](https://www.rfc-editor.org/rfc/rfc2616#section-3.3.1) defined in [RFC822](https://www.rfc-editor.org/rfc/rfc822#section-5) and updated in [RFC1123](https://www.rfc-editor.org/rfc/rfc1123#page-55)<!-- -->.
+
+**Signature:**
+
+```typescript
+export declare function formatDate(date: Date): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+date
+
+
+</td><td>
+
+Date
+
+
+</td><td>
+
+the date value to format
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+string
+
+## Example
+
+
+```
+formatDate(new Date(0)) === 'Thu, 01 Jan 1970 00:00:00 GMT`
+```
+

lib/cookie/formatDate.ts

@@ -1,7 +1,20 @@
 import * as validators from '../validators'
 import { safeToString } from '../utils'
 
-/** Converts a Date to a UTC string representation. */
+/**
+ * Format a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date | Date} into
+ * the {@link https://www.rfc-editor.org/rfc/rfc2616#section-3.3.1 | preferred Internet standard format}
+ * defined in {@link https://www.rfc-editor.org/rfc/rfc822#section-5 | RFC822} and
+ * updated in {@link https://www.rfc-editor.org/rfc/rfc1123#page-55 | RFC1123}.
+ *
+ * @example
+ * ```
+ * formatDate(new Date(0)) === 'Thu, 01 Jan 1970 00:00:00 GMT`
+ * ```
+ *
+ * @param date - the date value to format
+ * @public
+ */
 export function formatDate(date: Date): string {
   validators.validate(validators.isDate(date), safeToString(date))
   return date.toUTCString()