From 85e00bf66f20532f9586a5ad04f64f95ef550260 Mon Sep 17 00:00:00 2001 From: syuilo Date: Mon, 6 Feb 2017 06:58:04 +0900 Subject: [PATCH] Add some doc comments --- src/index.ts | 3 +++ src/summary.ts | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/src/index.ts b/src/index.ts index a56053c..4270122 100644 --- a/src/index.ts +++ b/src/index.ts @@ -31,6 +31,9 @@ type Options = { }; type Result = Summary & { + /** + * The actual url of that web page + */ url: string; }; diff --git a/src/summary.ts b/src/summary.ts index e5921fd..25d3c56 100644 --- a/src/summary.ts +++ b/src/summary.ts @@ -1,8 +1,27 @@ type Summary = { + /** + * The description of that web page + */ description: string; + + /** + * The url of the icon of that web page + */ icon: string; + + /** + * The name of site of that web page + */ sitename: string; + + /** + * The url of the thumbnail of that web page + */ thumbnail: string; + + /** + * The title of that web page + */ title: string; }