Update docs

wooorm · Nov 5, 2021 · f192dab · f192dab
1 parent 5c2bc5c
commit f192dab
Show file tree

Hide file tree

Showing 5 changed files with 194 additions and 107 deletions.
diff --git a/3.js b/3.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {'merge'|'change'|'split'} ISO31663Type
+ * @typedef {'merge'|'change'|'split'} Type
  *
  * @typedef ISO31661FromEntry
  * @property {'formerly-assigned'} state
@@ -19,7 +19,7 @@
  *   Object representing a former country.
  * @property {string} alpha4
  *   ISO 3166-3 alpha-4 code (example: `ANHH`)
- * @property {ISO31663Type} type
+ * @property {Type} type
  *   Type of revision (example: `'split'`)
  * @property {ISO31661FromEntry} from
  *   Country before revision

diff --git a/build-iso-3166-1-a2-table.js b/build-iso-3166-1-a2-table.js
@@ -92,7 +92,7 @@ export default function table() {
       const node = processor.runSync(
         // @ts-expect-error: fine to pass an element.
         h('details', [
-          h('summary', 'ISO 3166-1 alpha-2 code matrix'),
+          h('summary', 'Show ISO 3166-1 alpha-2 code matrix'),
           h('table', [h('thead', h('tr', head)), h('tbody', rows)])
         ])
       )

diff --git a/build.js b/build.js
@@ -703,7 +703,7 @@ Promise.resolve()
       iso31663,
       [
         '/**',
-        " * @typedef {'merge'|'change'|'split'} ISO31663Type",
+        " * @typedef {'merge'|'change'|'split'} Type",
         ' *',
         ' * @typedef ISO31661FromEntry',
         " * @property {'formerly-assigned'} state",
@@ -723,7 +723,7 @@ Promise.resolve()
         ' *   Object representing a former country.',
         ' * @property {string} alpha4',
         ' *   ISO 3166-3 alpha-4 code (example: `ANHH`)',
-        ' * @property {ISO31663Type} type',
+        ' * @property {Type} type',
         " *   Type of revision (example: `'split'`)",
         ' * @property {ISO31661FromEntry} from',
         ' *   Country before revision',

diff --git a/index.js b/index.js
@@ -1,9 +1,11 @@
 /**
  * @typedef {import('./1.js').ISO31661AssignedEntry} ISO31661AssignedEntry
  * @typedef {import('./1-reserved.js').ISO31661ReservedEntry} ISO31661ReservedEntry
+ * @typedef {ISO31661AssignedEntry|ISO31661ReservedEntry} ISO31661Entry
  * @typedef {import('./2.js').ISO31662Entry} ISO31662Entry
  * @typedef {import('./3.js').ISO31663Entry} ISO31663Entry
- * @typedef {ISO31661AssignedEntry|ISO31661ReservedEntry} ISO31661Entry
+ * @typedef {ISO31663Entry['type']} Type
+ * @typedef {ISO31661Entry['state']} State
  */
 
 export {iso31661} from './1.js'