export interface IGitHubRepos { name: string; topics: string[]; html_url: string; description: string; id: number; homepage: string; banner: string[]; } interface IUseGithubReposSimpleReturn { data: IGitHubRepos[] | undefined; isLoading: boolean; error: Error | null; } /** * ⚙️ github-automated-repos ( ) hook * - Control, choose and get data from your GitHub repositories in your `Portolio`. * @see {@link ℹ️ https://github.com/DIGOARTHUR/github-automated-repos} ⬅ for more info github-automated-repos documentation. * @example * // Usage Example import { useGitHubAutomatedRepos, StackIcons, StackLabels } from "github-automated-repos"; const { data, isLoading, error } = useGitHubAutomatedRepos('digoarthur', 'attached'); console.log(data) * @section 🪝 **Hook Params** * @param {string} gitHubUsername - Your GitHub username as seen in your profile URL. * Example: 'digoarthur' from https://github.com/USERNAME. * @param {string} keyWord - It is chosen by you. KeyWord used to identify and filter repositories (e.g., 'portfolio', 'attached'). * Set this KeyWord in GitHub at: * Repository → About '⚙️' → Topics → add your KeyWord. * Only repositories containing this KeyWord in their Topics will be returned. * @returns {object} Hook state object containing: * @type {object} IGitHubRepos * @property {string[]} banner - ⚠️ Array of banner image URLs found in the public folder. * The name of the image file must contain banner in the name. Insert your images inside project in the following path: e.g: * * File structure requirement: /public → bannerXYZ.png - bannerABC.svg - bannerJKL.jpg * * @property {string} name - Repository name. * @property {string[]} topics - Topics assigned to the repository. * @property {string} html_url - Repository URL. * @property {string} description - Short description of the repository. * @property {number} id - Unique repository ID. * @property {string} homepage - Homepage or deployed site URL. * @returns {IGitHubRepos[]|undefined} data - Array of filtered repositories, or `undefined` while loading. * @returns {boolean} isLoading - `true` while fetching data, otherwise `false`. * @returns {Error|null} error - Error object if the request failed, otherwise `null`. * @example * // Usage Example * * import { useGitHubAutomatedRepos, StackIcons, StackLabels } from "github-automated-repos"; * * ... * * const { data, isLoading } = useGitHubAutomatedRepos('digoarthur', 'attached'); * if (isLoading) return

; * * return ( *

* * {data?.map((repo) => ( *

{repo.name}

* *

* {repo.banner.map((url) => Banner

)} *

* *

* {repo.topics.map((stackName) => ( * * * * ))} *

* *

{repo.description}

* *

* 🔗 Homepage * 🔗 Repository *

* ))} * * *

* ); */ export declare const useGitHubAutomatedRepos: (gitHubUsername: string, keyWord: string) => IUseGithubReposSimpleReturn; export {};