Skip to content

Commit db410c2

Browse files
committed
update comments
1 parent 1d227b7 commit db410c2

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

src/data-connect/data-connect.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ export class DataConnect {
170170

171171
/**
172172
* Executes a GraphQL query. The query must be defined in your Data Connect GraphQL files.
173-
* Optionally, you may provide auth impersonation.
173+
* Optionally, you can provide auth impersonation details. If you don't
174+
* specify a value for this option, the query will run with admin privileges
175+
* and will ignore all auth directives.
174176
*
175177
* @param name - The name of the defined query to execute.
176178
* @param options - The GraphQL options, must include operationName and impersonation details.
@@ -183,7 +185,9 @@ export class DataConnect {
183185

184186
/**
185187
* Executes a GraphQL query. The query must be defined in your Data Connect GraphQL files.
186-
* Optionally, you may provide auth impersonation.
188+
* Optionally, you can provide auth impersonation details. If you don't
189+
* specify a value for this option, the query will run with admin privileges
190+
* and will ignore all auth directives.
187191
*
188192
* @param name - The name of the defined query to execute.
189193
* @param variables - The variables for the query. May be optional if the query's variables are optional.
@@ -206,7 +210,9 @@ export class DataConnect {
206210

207211
/**
208212
* Executes a GraphQL mutation. The mutation must be defined in your Data Connect GraphQL files.
209-
* Optionally, you may provide auth impersonation.
213+
* Optionally, you can provide auth impersonation details. If you don't
214+
* specify a value for this option, the query will run with admin privileges
215+
* and will ignore all auth directives.
210216
*
211217
* @param name - The name of the defined mutation to execute.
212218
* @param options - The GraphQL options, must include operationName and impersonation details.
@@ -219,7 +225,9 @@ export class DataConnect {
219225

220226
/**
221227
* Executes a GraphQL mutation. The mutation must be defined in your Data Connect GraphQL files.
222-
* Optionally, you may provide auth impersonation.
228+
* Optionally, you can provide auth impersonation details. If you don't
229+
* specify a value for this option, the query will run with admin privileges
230+
* and will ignore all auth directives.
223231
*
224232
* @param name - The name of the defined mutation to execute.
225233
* @param variables - The variables for the mutation. May be optional if the mutation's variables are optional.

0 commit comments

Comments
 (0)