🚧Add state type for issue and pr models (#96)

* Start work for issue #82 * enhance: create new type to represent the state of an issue or pr * enhance: update models to use state type
KinsonDigital · Oct 15, 2024 · fe672b6 · fe672b6
1 parent d41f178
commit fe672b6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/core/Models/IssueModel.ts b/core/Models/IssueModel.ts
@@ -1,3 +1,4 @@
+import type { State } from "../Types.ts";
 import type { LabelModel } from "./mod.ts";
 import type { MilestoneModel } from "./mod.ts";
 import type { UserModel } from "./mod.ts";
@@ -29,7 +30,7 @@ export interface IssueModel {
 	/**
 	 * Gets or sets the state of the issue.
 	 */
-	state?: string;
+	state?: State;
 
 	/**
 	 * Gets or sets the URL to the html page of the issue.

diff --git a/core/Models/PullRequestModel.ts b/core/Models/PullRequestModel.ts
@@ -1,3 +1,4 @@
+import type { State } from "../Types.ts";
 import type { LabelModel } from "./mod.ts";
 import type { MilestoneModel } from "./mod.ts";
 import type { PullRequestHeadOrBaseModel } from "./mod.ts";
@@ -51,7 +52,7 @@ export interface PullRequestModel {
 	/**
 	 * Gets or sets the state of the pull request.
 	 */
-	state?: string;
+	state?: State;
 
 	/**
 	 * Gets or sets the URL to the pull request.

diff --git a/core/Types.ts b/core/Types.ts
@@ -6,6 +6,11 @@ import type { PullRequestModel } from "../deps.ts";
  */
 export type ItemType = "issue" | "pull-request";
 
+/**
+ * Represents the state of a GitHub issue or pull request.
+ */
+export type State = "open" | "closed";
+
 /**
  * Represents a GitHub issue or pull request.
  */