prefix IssuesFilters and IssuesOrdering with Github

Signed-off-by: Paul Cowan <paul.cowan@cutting.scot>
This commit is contained in:
Paul Cowan
2022-10-07 13:06:08 +01:00
parent 27828db4a7
commit 663fd697f1
3 changed files with 16 additions and 11 deletions
@@ -76,7 +76,7 @@ export type GitHubIssuesApi = ReturnType<typeof gitHubIssuesApi>;
/**
* @public
*/
export interface IssuesFilters {
export interface GithubIssuesFilters {
assignee?: string;
createdBy?: string;
labels?: string[];
@@ -88,7 +88,7 @@ export interface IssuesFilters {
/**
* @public
*/
export interface IssuesOrdering {
export interface GithubIssuesOrdering {
field: 'CREATED_AT' | 'UPDATED_AT' | 'COMMENTS';
direction?: 'ASC' | 'DESC';
}
@@ -97,8 +97,8 @@ export interface IssuesOrdering {
* @public
*/
export interface IssuesByRepoOptions {
filterBy?: IssuesFilters;
orderBy?: IssuesOrdering;
filterBy?: GithubIssuesFilters;
orderBy?: GithubIssuesOrdering;
}
/** @internal */
@@ -189,7 +189,9 @@ export const gitHubIssuesApi = (
return { fetchIssuesByRepoFromGitHub };
};
function formatFilterValue(value: IssuesFilters[keyof IssuesFilters]): string {
function formatFilterValue(
value: GithubIssuesFilters[keyof GithubIssuesFilters],
): string {
if (Array.isArray(value)) {
return `[ ${value.map(formatFilterValue).join(', ')}]`;
}
@@ -197,7 +199,7 @@ function formatFilterValue(value: IssuesFilters[keyof IssuesFilters]): string {
return typeof value === 'string' ? `\"${value}\"` : `${value}`;
}
function createFilterByClause(filterBy?: IssuesFilters): string {
function createFilterByClause(filterBy?: GithubIssuesFilters): string {
if (!filterBy) {
return '';
}
@@ -24,7 +24,10 @@ import { useGetIssuesByRepoFromGitHub } from '../../hooks/useGetIssuesByRepoFrom
import { IssuesList } from './IssuesList';
import { NoRepositoriesInfo } from './NoRepositoriesInfo';
import type { IssuesFilters, IssuesOrdering } from '../../api/gitHubIssuesApi';
import type {
GithubIssuesFilters,
GithubIssuesOrdering,
} from '../../api/gitHubIssuesApi';
/**
* @public
@@ -32,8 +35,8 @@ import type { IssuesFilters, IssuesOrdering } from '../../api/gitHubIssuesApi';
export type GitHubIssuesProps = {
itemsPerPage?: number;
itemsPerRepo?: number;
filterBy?: IssuesFilters;
orderBy?: IssuesOrdering;
filterBy?: GithubIssuesFilters;
orderBy?: GithubIssuesOrdering;
};
export const GitHubIssues = (props: GitHubIssuesProps) => {
+2 -2
View File
@@ -21,7 +21,7 @@ export {
export type { GitHubIssuesProps } from './components/GitHubIssues';
export type {
IssuesFilters,
IssuesOrdering,
GithubIssuesFilters,
GithubIssuesOrdering,
IssuesByRepoOptions,
} from './api/gitHubIssuesApi';