mirror of
https://github.com/misskey-dev/summaly.git
synced 2025-06-25 21:07:55 +09:00
Add some doc comments
This commit is contained in:
parent
59d9be5657
commit
85e00bf66f
@ -31,6 +31,9 @@ type Options = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
type Result = Summary & {
|
type Result = Summary & {
|
||||||
|
/**
|
||||||
|
* The actual url of that web page
|
||||||
|
*/
|
||||||
url: string;
|
url: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -1,8 +1,27 @@
|
|||||||
type Summary = {
|
type Summary = {
|
||||||
|
/**
|
||||||
|
* The description of that web page
|
||||||
|
*/
|
||||||
description: string;
|
description: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The url of the icon of that web page
|
||||||
|
*/
|
||||||
icon: string;
|
icon: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of site of that web page
|
||||||
|
*/
|
||||||
sitename: string;
|
sitename: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The url of the thumbnail of that web page
|
||||||
|
*/
|
||||||
thumbnail: string;
|
thumbnail: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of that web page
|
||||||
|
*/
|
||||||
title: string;
|
title: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user