feat: add open graph image alt type (#102)

jacktuck · Dec 5, 2022 · 23211f2 · 23211f2
1 parent cd3f189
commit 23211f2
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -113,6 +113,7 @@ type Metadata = {
       type: string
       width: number
       height: number
+      alt?: string
     }[]
     url?: string
     audio?: {

diff --git a/src/schema.ts b/src/schema.ts
@@ -167,6 +167,10 @@ export const schema = new Map([
     "og:image:height",
     { entry: "open_graph", name: "height", parent: "images", type: "number" },
   ],
+  [
+    "og:image:alt",
+    { entry: "open_graph", name: "alt", parent: "images", type: "string" },
+  ],
   [
     "og:image:type",
     { entry: "open_graph", name: "type", parent: "images", type: "string" },

diff --git a/src/types.ts b/src/types.ts
@@ -85,6 +85,7 @@ export type Metadata = {
       type: string;
       width: number;
       height: number;
+      alt?: string;
     }[];
     url?: string;
     audio?: {

diff --git a/test/open_graph/images.html b/test/open_graph/images.html
@@ -5,6 +5,7 @@
     <meta property="og:image:type" content="image/png">
     <meta property="og:image:width" content="1200">
     <meta property="og:image:height" content="1200">
+    <meta property="og:image:alt" content="The Github logo.">
     <meta property="og:image" content="https://assets-cdn.github.com/images/modules/open_graph/github-mark.png">
     <meta property="og:image:type" content="image/png">
     <meta property="og:image:width" content="1200">
@@ -13,6 +14,7 @@
     <meta property="og:image:type" content="image/png">
     <meta property="og:image:width" content="1200">
     <meta property="og:image:height" content="620">
+    <meta property="og:image:alt" content="The Github octocat.">
   </head>
   <body></body>
 </html>
diff --git a/test/open_graph/test.ts b/test/open_graph/test.ts
@@ -49,6 +49,7 @@ test("should build images[]", async () => {
         type: "image/png",
         width: 1200,
         height: 1200,
+        alt: "The Github logo.",
       },
       {
         url: "https://assets-cdn.github.com/images/modules/open_graph/github-mark.png",
@@ -61,6 +62,7 @@ test("should build images[]", async () => {
         type: "image/png",
         width: 1200,
         height: 620,
+        alt: "The Github octocat.",
       },
     ],
   };