Skip to content

Commit 3cb6645

Browse files
committed
cleanup javadocs to address workflow failures
1 parent 52a18d7 commit 3cb6645

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

src/data-connect/data-connect.ts

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,7 @@ export class DataConnect {
173173

174174
/**
175175
* Create a reference to a specific "instance" of a named query.
176-
* @param name Name of query
177-
* @param impersonate Impersonation options for this query
176+
* @param options - Required {@link GraphqlOptions} when executing a GraphQL query.
178177
* @returns an reference to the named query with the specified impersonation and variables.
179178
*/
180179
public queryRef<Data>(
@@ -183,9 +182,7 @@ export class DataConnect {
183182

184183
/**
185184
* Create a reference to a specific "instance" of a named query.
186-
* @param name Name of query
187-
* @param impersonate Impersonation options for this query
188-
* @param variables Variables passed to this query, may be omitted.
185+
* @param options - Required {@link GraphqlOptions} when executing a GraphQL query.
189186
* @returns an reference to the named query with the specified impersonation and variables.
190187
*/
191188
public queryRef<Data, Variables>(
@@ -206,8 +203,7 @@ export class DataConnect {
206203

207204
/**
208205
* Create a reference to a specific "instance" of a named mutation.
209-
* @param name Name of mutation
210-
* @param impersonate Impersonation options for this mutation
206+
* @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
211207
* @returns an reference to the named mutation with the specified impersonation and variables.
212208
*/
213209
public mutationRef<Data>(
@@ -216,19 +212,16 @@ export class DataConnect {
216212

217213
/**
218214
* Create a reference to a specific "instance" of a named mutation.
219-
* @param name Name of mutation
220-
* @param impersonate Impersonation options for this mutation
221-
* @param variables Variables passed to this mutation, may be omitted.
215+
* @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
222216
* @returns an reference to the named mutation with the specified impersonation and variables.
223217
*/
224218
public mutationRef<Data, Variables>(
225219
options: GraphqlOptions<Variables>
226-
): MutationRef<Data, Variables>;
220+
): MutationRef<Data, Variables>;
221+
227222
/**
228223
* Create a reference to a specific "instance" of a named mutation.
229-
* @param name Name of mutation
230-
* @param impersonate Impersonation options for this mutation
231-
* @param variables Variables passed to this mutation, may be omitted.
224+
* @param options - Required {@link GraphqlOptions} when executing a GraphQL mutation.
232225
* @returns an reference to the named mutation with the specified impersonation and variables.
233226
*/
234227
public mutationRef<Data, Variables>(

0 commit comments

Comments
 (0)