Skip to content

Commit d3b57af

Browse files
style(js): Minor formatting consistency cleanup in remove-preview-deployments (#7371)
1 parent 7aca7eb commit d3b57af

File tree

1 file changed

+89
-29
lines changed

1 file changed

+89
-29
lines changed

scripts/remove-preview-deployments.ts

Lines changed: 89 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -32,64 +32,116 @@ if (!VERCEL_PROJECT_ID) {
3232
throw new Error('VERCEL_PROJECT_ID is not set');
3333
}
3434

35-
/** This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. */
35+
/**
36+
* This object contains information related to the pagination of the current
37+
* request, including the necessary parameters to get the next or previous page
38+
* of data.
39+
*/
3640
interface Pagination {
37-
/** Amount of items in the current page. */
41+
/**
42+
* Amount of items in the current page.
43+
*/
3844
count: number;
39-
/** Timestamp that must be used to request the next page. */
45+
/**
46+
* Timestamp that must be used to request the next page.
47+
*/
4048
next: number | null;
41-
/** Timestamp that must be used to request the previous page. */
49+
/**
50+
* Timestamp that must be used to request the previous page.
51+
*/
4252
prev: number | null;
4353
}
4454

4555
interface Response {
4656
deployments: {
47-
/** Timestamp of when the deployment got created. */
57+
/**
58+
* Timestamp of when the deployment got created.
59+
* */
4860
created: number;
49-
/** Metadata information of the user who created the deployment. */
61+
/**
62+
* Metadata information of the user who created the deployment.
63+
*/
5064
creator: {
51-
/** The unique identifier of the user. */
65+
/**
66+
* The unique identifier of the user.
67+
*/
5268
uid: string;
53-
/** The email address of the user. */
69+
/**
70+
* The email address of the user.
71+
*/
5472
email?: string;
55-
/** The GitHub login of the user. */
73+
/**
74+
* The GitHub login of the user.
75+
*/
5676
githubLogin?: string;
57-
/** The GitLab login of the user. */
77+
/**
78+
* The GitLab login of the user.
79+
*/
5880
gitlabLogin?: string;
59-
/** The username of the user. */
81+
/**
82+
* The username of the user.
83+
*/
6084
username?: string;
6185
};
62-
/** Vercel URL to inspect the deployment. */
86+
/**
87+
* Vercel URL to inspect the deployment.
88+
*/
6389
inspectorUrl: string | null;
64-
/** The name of the deployment. */
90+
/**
91+
* The name of the deployment.
92+
*/
6593
name: string;
66-
/** The type of the deployment. */
94+
/**
95+
* The type of the deployment.
96+
*/
6797
type: 'LAMBDAS';
68-
/** The unique identifier of the deployment. */
98+
/**
99+
* The unique identifier of the deployment.
100+
*/
69101
uid: string;
70-
/** The URL of the deployment. */
102+
/**
103+
* The URL of the deployment.
104+
*/
71105
url: string;
72106
aliasAssigned?: (number | boolean) | null;
73-
/** An error object in case aliasing of the deployment failed. */
107+
/**
108+
* An error object in case aliasing of the deployment failed.
109+
*/
74110
aliasError?: {
75111
code: string;
76112
message: string;
77113
} | null;
78-
/** Timestamp of when the deployment started building at. */
114+
/**
115+
* Timestamp of when the deployment started building at.
116+
*/
79117
buildingAt?: number;
80-
/** Conclusion for checks */
118+
/**
119+
* Conclusion for checks
120+
*/
81121
checksConclusion?: 'succeeded' | 'failed' | 'skipped' | 'canceled';
82-
/** State of all registered checks */
122+
/**
123+
* State of all registered checks
124+
*/
83125
checksState?: 'registered' | 'running' | 'completed';
84-
/** The ID of Vercel Connect configuration used for this deployment */
126+
/**
127+
* The ID of Vercel Connect configuration used for this deployment
128+
*/
85129
connectConfigurationId?: string;
86-
/** Timestamp of when the deployment got created. */
130+
/**
131+
* Timestamp of when the deployment got created.
132+
*/
87133
createdAt?: number;
88-
/** Deployment can be used for instant rollback */
134+
/**
135+
* Deployment can be used for instant rollback
136+
*/
89137
isRollbackCandidate?: boolean | null;
90-
/** An object containing the deployment's metadata */
138+
/**
139+
* An object containing the deployment's metadata
140+
*/
91141
meta?: {[key: string]: string};
92-
/** The project settings which was used for this deployment */
142+
/**
143+
* The project settings which was used for this deployment
144+
*/
93145
projectSettings?: {
94146
buildCommand?: string | null;
95147
commandForIgnoringBuildStep?: string | null;
@@ -151,13 +203,21 @@ interface Response {
151203
skipGitConnectDuringLink?: boolean;
152204
sourceFilesOutsideRootDirectory?: boolean;
153205
};
154-
/** Timestamp of when the deployment got ready. */
206+
/**
207+
* Timestamp of when the deployment got ready.
208+
*/
155209
ready?: number;
156-
/** The source of the deployment. */
210+
/**
211+
* The source of the deployment.
212+
*/
157213
source?: 'cli' | 'git' | 'import' | 'import/repo' | 'clone/repo';
158-
/** In which state is the deployment. */
214+
/**
215+
* In which state is the deployment.
216+
*/
159217
state?: 'BUILDING' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY' | 'CANCELED';
160-
/** On which environment has the deployment been deployed to. */
218+
/**
219+
* On which environment has the deployment been deployed to.
220+
*/
161221
target?: ('production' | 'staging') | null;
162222
}[];
163223
pagination: Pagination;

0 commit comments

Comments
 (0)