Order the README API reference Address4, Address6, AddressError

Source order put the error type first, which is not what a reader opening the
reference is looking for.

Author: beaugunderson

README.md

@@ -98,19 +98,6 @@ A few terms used throughout the API can be confusing if you haven't worked deepl
 
 <!-- API:START -->
 
-<details>
-<summary><a id="addresserror"></a><strong>AddressError</strong></summary>
-
-**Constructor**
-
-- `new AddressError(message: string, parseMessage?: string): AddressError`
-
-**Properties**
-
-- `parseMessage: string` — [src](https://github.com/beaugunderson/ip-address/blob/master/src/address-error.ts#L2)
-
-</details>
-
 <details>
 <summary><a id="address4"></a><strong>Address4</strong> — Represents an IPv4 address</summary>
 
@@ -273,6 +260,19 @@ A few terms used throughout the API can be confusing if you haven't worked deepl
 
 </details>
 
+<details>
+<summary><a id="addresserror"></a><strong>AddressError</strong></summary>
+
+**Constructor**
+
+- `new AddressError(message: string, parseMessage?: string): AddressError`
+
+**Properties**
+
+- `parseMessage: string` — [src](https://github.com/beaugunderson/ip-address/blob/master/src/address-error.ts#L2)
+
+</details>
+
 <!-- API:END -->
 
 ### Used by

scripts/build-readme.ts

@@ -76,6 +76,8 @@ function renderProperty(prop: TypeDoc.DeclarationReflection): string {
   return `- ${code}${tail ? ' — ' + tail : ''}`;
 }
 
+const CLASS_ORDER = ['Address4', 'Address6', 'AddressError'];
+
 function escapeHtml(text: string): string {
   return text
     .replace(/&/g, '&')
@@ -195,9 +197,9 @@ async function main() {
   const project = await app.convert();
   if (!project) throw new Error('TypeDoc failed to convert the project');
 
-  const classes = (project.children ?? []).filter(
-    (c) => c.kind === TypeDoc.ReflectionKind.Class,
-  );
+  const classes = (project.children ?? [])
+    .filter((c) => c.kind === TypeDoc.ReflectionKind.Class)
+    .sort((a, b) => CLASS_ORDER.indexOf(a.name) - CLASS_ORDER.indexOf(b.name));
 
   const sections: string[] = [];
   for (const cls of classes) {