moved type definitions to a separate directory and fixed some documentations under utils/

This commit is contained in:
2024-11-17 18:06:59 +09:00
parent 1ab17242f7
commit 1c4947e4e3
11 changed files with 3 additions and 4 deletions

22
utils/types/linkCard.ts Normal file
View File

@@ -0,0 +1,22 @@
/**
* Type for LinkCard component
* @module utils/linkCard
*/
/**
* Interface that defines property for LinkCard component
* @property {string} title title of link
* @property {string} description description of link
* @property {string} link link itself
* @property {string=} imagePath optional path to image to display with
* @example
* <LinkCard title="Test Article" description="Test entry for the website." link="/blog/test" image-path="blog-cover-image.jpg" />
*/
interface LinkCardProperty {
title: string;
description: string;
link: string;
imagePath?: string;
}
export type { LinkCardProperty };