Skip to content

Commit 5721657

Browse files
committed
update comments
1 parent 89e691a commit 5721657

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/data-connect/data-connect.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,10 @@ export class DataConnect {
169169
}
170170

171171
/**
172-
* Executes a deployed GraphQL query, optionally with auth impersonation.
173-
*
174-
* The query must be defined in your Data Connect GraphQL files.
172+
* Executes a GraphQL query. The query must be defined in your Data Connect GraphQL files.
173+
* Optionally, you may provide auth impersonation.
175174
*
175+
* @param name - The name of the defined query to execute.
176176
* @param options - The GraphQL options, must include operationName and impersonation details.
177177
* @returns A promise that fulfills with the GraphQL response.
178178
*/
@@ -182,10 +182,10 @@ export class DataConnect {
182182
): Promise<ExecuteOperationResponse<Data>>;
183183

184184
/**
185-
* Executes a pre-defined GraphQL query, optionally with auth impersonation.
186-
*
187-
* The query must be defined in your Data Connect GraphQL files.
185+
* Executes a GraphQL query. The query must be defined in your Data Connect GraphQL files.
186+
* Optionally, you may provide auth impersonation.
188187
*
188+
* @param name - The name of the defined query to execute.
189189
* @param options - The GraphQL options, must include operationName and impersonation details.
190190
* @param variables - The variables for the query. May be optional if the query's variables are optional.
191191
* @returns A promise that fulfills with the GraphQL response.
@@ -205,10 +205,10 @@ export class DataConnect {
205205
}
206206

207207
/**
208-
* Executes a pre-defined GraphQL mutation, optionally with auth impersonation.
209-
*
210-
* The mutation must be defined in your Data Connect GQL files.
208+
* Executes a GraphQL mutation. The mutation must be defined in your Data Connect GraphQL files.
209+
* Optionally, you may provide auth impersonation.
211210
*
211+
* @param name - The name of the defined mutation to execute.
212212
* @param options - The GraphQL options, must include operationName and impersonation details.
213213
* @returns A promise that fulfills with the GraphQL response.
214214
*/
@@ -218,10 +218,10 @@ export class DataConnect {
218218
): Promise<ExecuteOperationResponse<Data>>;
219219

220220
/**
221-
* Executes a pre-defined GraphQL mutation, optionally with auth impersonation.
222-
*
223-
* The mutation must be defined in your Data Connect GQL files.
221+
* Executes a GraphQL mutation. The mutation must be defined in your Data Connect GraphQL files.
222+
* Optionally, you may provide auth impersonation.
224223
*
224+
* @param name - The name of the defined mutation to execute.
225225
* @param options - The GraphQL options, must include operationName and impersonation details.
226226
* @param variables - The variables for the mutation. May be optional if the mutation's variables are optional.
227227
* @returns A promise that fulfills with the GraphQL response.

0 commit comments

Comments
 (0)