Add type definitions

This commit is contained in:
Ariful Alam 2022-03-26 13:30:43 +06:00
parent 8dedc09ea8
commit 9f24ddbe46
2 changed files with 58 additions and 0 deletions

View File

@ -21,6 +21,7 @@
},
"./dist/style.css": "./dist/style.css"
},
"typings": "./types/index.d.ts",
"scripts": {
"dev": "vite",
"build": "vite build",

57
types/index.d.ts vendored Normal file
View File

@ -0,0 +1,57 @@
// Type definitions for GitProfile
// Project https://github.com/arifszn/gitprofile
// Author: Ariful Alam <arifulalamszn@gmail.com>
import { Component } from 'react';
interface github {
/**
* GitHub org/user name
*/
username: string;
/**
* stars | updated
*/
sortBy: string;
/**
* How many projects to display
*/
limit: number;
/**
* Exclude projects option
*/
exclude: {
/**
* Forked projects will not be displayed if set to true
*/
forks: boolean;
/**
* These projects will not be displayed
*
* example: ['my-project1', 'my-project2']
*/
projects: Array;
};
}
interface config {
/**
* GitHub Config
*/
github: github;
}
interface GitProfileProps {
/**
* Config values
*/
config: config;
}
declare class GitProfile extends Component<GitProfileProps> {}
export default GitProfile;