1
+ <!DOCTYPE html>
2
+ < html >
3
+ < head >
4
+ < meta charset ="utf-8 ">
5
+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
6
+ < title >
7
+ Class: GraphQL::Analysis::FieldUsage
8
+
9
+ — GraphQL Ruby API Documentation
10
+
11
+ </ title >
12
+
13
+ < link rel ="stylesheet " href ="../../css/style.css " type ="text/css " />
14
+
15
+ < link rel ="stylesheet " href ="../../css/common.css " type ="text/css " />
16
+
17
+ < script type ="text/javascript ">
18
+ pathId = "GraphQL::Analysis::FieldUsage" ;
19
+ relpath = '../../' ;
20
+ </ script >
21
+
22
+
23
+ < script type ="text/javascript " charset ="utf-8 " src ="../../js/jquery.js "> </ script >
24
+
25
+ < script type ="text/javascript " charset ="utf-8 " src ="../../js/app.js "> </ script >
26
+
27
+
28
+ </ head >
29
+ < body >
30
+ < div class ="nav_wrap ">
31
+ < iframe id ="nav " src ="../../class_list.html?1 "> </ iframe >
32
+ < div id ="resizer "> </ div >
33
+ </ div >
34
+
35
+ < div id ="main " tabindex ="-1 ">
36
+ < div id ="header ">
37
+ < div id ="menu ">
38
+
39
+ < a href ="../../_index.html "> Index (F)</ a > »
40
+ < span class ='title '> < span class ='object_link '> < a href ="../../GraphQL.html " title ="GraphQL (module) "> GraphQL</ a > </ span > </ span > » < span class ='title '> < span class ='object_link '> < a href ="../Analysis.html " title ="GraphQL::Analysis (module) "> Analysis</ a > </ span > </ span >
41
+ »
42
+ < span class ="title "> FieldUsage</ span >
43
+
44
+ </ div >
45
+
46
+ < div id ="search ">
47
+
48
+ < a class ="full_list_link " id ="class_list_link "
49
+ href ="../../class_list.html ">
50
+
51
+ < svg width ="24 " height ="24 ">
52
+ < rect x ="0 " y ="4 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
53
+ < rect x ="0 " y ="12 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
54
+ < rect x ="0 " y ="20 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
55
+ </ svg >
56
+ </ a >
57
+
58
+ </ div >
59
+ < div class ="clear "> </ div >
60
+ </ div >
61
+
62
+ < div id ="content "> < h1 > Class: GraphQL::Analysis::FieldUsage
63
+
64
+
65
+
66
+ </ h1 >
67
+ < div class ="box_info ">
68
+
69
+ < dl >
70
+ < dt > Inherits:</ dt >
71
+ < dd >
72
+ < span class ="inheritName "> < span class ='object_link '> < a href ="Analyzer.html " title ="GraphQL::Analysis::Analyzer (class) "> Analyzer</ a > </ span > </ span >
73
+
74
+ < ul class ="fullTree ">
75
+ < li > Object</ li >
76
+
77
+ < li class ="next "> < span class ='object_link '> < a href ="Analyzer.html " title ="GraphQL::Analysis::Analyzer (class) "> Analyzer</ a > </ span > </ li >
78
+
79
+ < li class ="next "> GraphQL::Analysis::FieldUsage</ li >
80
+
81
+ </ ul >
82
+ < a href ="# " class ="inheritanceTree "> show all</ a >
83
+
84
+ </ dd >
85
+ </ dl >
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ < dl >
98
+ < dt > Defined in:</ dt >
99
+ < dd > lib/graphql/analysis/field_usage.rb</ dd >
100
+ </ dl >
101
+
102
+ </ div >
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ < h2 >
113
+ Instance Method Summary
114
+ < small > < a href ="# " class ="summary_toggle "> collapse</ a > </ small >
115
+ </ h2 >
116
+
117
+ < ul class ="summary ">
118
+
119
+ < li class ="public ">
120
+ < span class ="summary_signature ">
121
+
122
+ < a href ="#initialize-instance_method " title ="#initialize (instance method) "> #< strong > initialize</ strong > (query) ⇒ FieldUsage </ a >
123
+
124
+
125
+
126
+ </ span >
127
+
128
+
129
+ < span class ="note title constructor "> constructor</ span >
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ < span class ="summary_desc "> < div class ='inline '> < p > A new instance of FieldUsage.</ p >
139
+ </ div > </ span >
140
+
141
+ </ li >
142
+
143
+
144
+ < li class ="public ">
145
+ < span class ="summary_signature ">
146
+
147
+ < a href ="#on_leave_field-instance_method " title ="#on_leave_field (instance method) "> #< strong > on_leave_field</ strong > (node, parent, visitor) ⇒ Object </ a >
148
+
149
+
150
+
151
+ </ span >
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+ < span class ="summary_desc "> < div class ='inline '>
162
+ </ div > </ span >
163
+
164
+ </ li >
165
+
166
+
167
+ < li class ="public ">
168
+ < span class ="summary_signature ">
169
+
170
+ < a href ="#result-instance_method " title ="#result (instance method) "> #< strong > result</ strong > ⇒ Object </ a >
171
+
172
+
173
+
174
+ </ span >
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ < span class ="summary_desc "> < div class ='inline '>
185
+ </ div > </ span >
186
+
187
+ </ li >
188
+
189
+
190
+ </ ul >
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ < h3 class ="inherited "> Methods inherited from < span class ='object_link '> < a href ="Analyzer.html " title ="GraphQL::Analysis::Analyzer (class) "> Analyzer</ a > </ span > </ h3 >
203
+ < p class ="inherited "> < span class ='object_link '> < a href ="Analyzer.html#analyze%3F-instance_method " title ="GraphQL::Analysis::Analyzer#analyze? (method) "> #analyze?</ a > </ span > , < span class ='object_link '> < a href ="Analyzer.html#visit%3F-instance_method " title ="GraphQL::Analysis::Analyzer#visit? (method) "> #visit?</ a > </ span > </ p >
204
+ < div id ="constructor_details " class ="method_details_list ">
205
+ < h2 > Constructor Details</ h2 >
206
+
207
+ < div class ="method_details first ">
208
+ < h3 class ="signature first " id ="initialize-instance_method ">
209
+
210
+ #< strong > initialize</ strong > (query) ⇒ < tt > < span class ='object_link '> < a href ="" title ="GraphQL::Analysis::FieldUsage (class) "> FieldUsage</ a > </ span > </ tt >
211
+
212
+
213
+
214
+
215
+
216
+ </ h3 > < div class ="docstring ">
217
+ < div class ="discussion ">
218
+ < p > Returns a new instance of FieldUsage.</ p >
219
+
220
+
221
+ </ div >
222
+ </ div >
223
+ < div class ="tags ">
224
+
225
+
226
+ </ div > < table class ="source_code ">
227
+ < tr >
228
+ < td >
229
+ < pre class ="lines ">
230
+
231
+
232
+ 5
233
+ 6
234
+ 7
235
+ 8
236
+ 9
237
+ 10
238
+ 11</ pre >
239
+ </ td >
240
+ < td >
241
+ < pre class ="code "> < span class ="info file "> # File 'lib/graphql/analysis/field_usage.rb', line 5</ span >
242
+
243
+ < span class ='kw '> def</ span > < span class ='id identifier rubyid_initialize '> initialize</ span > < span class ='lparen '> (</ span > < span class ='id identifier rubyid_query '> query</ span > < span class ='rparen '> )</ span >
244
+ < span class ='kw '> super</ span >
245
+ < span class ='ivar '> @used_fields</ span > < span class ='op '> =</ span > < span class ='const '> Set</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_new '> new</ span >
246
+ < span class ='ivar '> @used_deprecated_fields</ span > < span class ='op '> =</ span > < span class ='const '> Set</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_new '> new</ span >
247
+ < span class ='ivar '> @used_deprecated_arguments</ span > < span class ='op '> =</ span > < span class ='const '> Set</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_new '> new</ span >
248
+ < span class ='ivar '> @used_deprecated_enum_values</ span > < span class ='op '> =</ span > < span class ='const '> Set</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_new '> new</ span >
249
+ < span class ='kw '> end</ span > </ pre >
250
+ </ td >
251
+ </ tr >
252
+ </ table >
253
+ </ div >
254
+
255
+ </ div >
256
+
257
+
258
+ < div id ="instance_method_details " class ="method_details_list ">
259
+ < h2 > Instance Method Details</ h2 >
260
+
261
+
262
+ < div class ="method_details first ">
263
+ < h3 class ="signature first " id ="on_leave_field-instance_method ">
264
+
265
+ #< strong > on_leave_field</ strong > (node, parent, visitor) ⇒ < tt > Object</ tt >
266
+
267
+
268
+
269
+
270
+
271
+ </ h3 > < table class ="source_code ">
272
+ < tr >
273
+ < td >
274
+ < pre class ="lines ">
275
+
276
+
277
+ 13
278
+ 14
279
+ 15
280
+ 16
281
+ 17
282
+ 18
283
+ 19
284
+ 20
285
+ 21
286
+ 22
287
+ 23
288
+ 24</ pre >
289
+ </ td >
290
+ < td >
291
+ < pre class ="code "> < span class ="info file "> # File 'lib/graphql/analysis/field_usage.rb', line 13</ span >
292
+
293
+ < span class ='kw '> def</ span > < span class ='id identifier rubyid_on_leave_field '> on_leave_field</ span > < span class ='lparen '> (</ span > < span class ='id identifier rubyid_node '> node</ span > < span class ='comma '> ,</ span > < span class ='id identifier rubyid_parent '> parent</ span > < span class ='comma '> ,</ span > < span class ='id identifier rubyid_visitor '> visitor</ span > < span class ='rparen '> )</ span >
294
+ < span class ='id identifier rubyid_field_defn '> field_defn</ span > < span class ='op '> =</ span > < span class ='id identifier rubyid_visitor '> visitor</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_field_definition '> field_definition</ span >
295
+ < span class ='id identifier rubyid_field '> field</ span > < span class ='op '> =</ span > < span class ='tstring '> < span class ='tstring_beg '> "</ span > < span class ='embexpr_beg '> #{</ span > < span class ='id identifier rubyid_visitor '> visitor</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_parent_type_definition '> parent_type_definition</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_graphql_name '> graphql_name</ span > < span class ='embexpr_end '> }</ span > < span class ='tstring_content '> .</ span > < span class ='embexpr_beg '> #{</ span > < span class ='id identifier rubyid_field_defn '> field_defn</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_graphql_name '> graphql_name</ span > < span class ='embexpr_end '> }</ span > < span class ='tstring_end '> "</ span > </ span >
296
+ < span class ='ivar '> @used_fields</ span > < span class ='op '> <<</ span > < span class ='id identifier rubyid_field '> field</ span >
297
+ < span class ='ivar '> @used_deprecated_fields</ span > < span class ='op '> <<</ span > < span class ='id identifier rubyid_field '> field</ span > < span class ='kw '> if</ span > < span class ='id identifier rubyid_field_defn '> field_defn</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_deprecation_reason '> deprecation_reason</ span >
298
+ < span class ='id identifier rubyid_arguments '> arguments</ span > < span class ='op '> =</ span > < span class ='id identifier rubyid_visitor '> visitor</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_query '> query</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_arguments_for '> arguments_for</ span > < span class ='lparen '> (</ span > < span class ='id identifier rubyid_node '> node</ span > < span class ='comma '> ,</ span > < span class ='id identifier rubyid_field_defn '> field_defn</ span > < span class ='rparen '> )</ span >
299
+ < span class ='comment '> # If there was an error when preparing this argument object,
300
+ </ span > < span class ='comment '> # then this might be an error or something:
301
+ </ span > < span class ='kw '> if</ span > < span class ='id identifier rubyid_arguments '> arguments</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_respond_to? '> respond_to?</ span > < span class ='lparen '> (</ span > < span class ='symbol '> :argument_values</ span > < span class ='rparen '> )</ span >
302
+ < span class ='id identifier rubyid_extract_deprecated_arguments '> extract_deprecated_arguments</ span > < span class ='lparen '> (</ span > < span class ='id identifier rubyid_arguments '> arguments</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_argument_values '> argument_values</ span > < span class ='rparen '> )</ span >
303
+ < span class ='kw '> end</ span >
304
+ < span class ='kw '> end</ span > </ pre >
305
+ </ td >
306
+ </ tr >
307
+ </ table >
308
+ </ div >
309
+
310
+ < div class ="method_details ">
311
+ < h3 class ="signature " id ="result-instance_method ">
312
+
313
+ #< strong > result</ strong > ⇒ < tt > Object</ tt >
314
+
315
+
316
+
317
+
318
+
319
+ </ h3 > < table class ="source_code ">
320
+ < tr >
321
+ < td >
322
+ < pre class ="lines ">
323
+
324
+
325
+ 26
326
+ 27
327
+ 28
328
+ 29
329
+ 30
330
+ 31
331
+ 32
332
+ 33</ pre >
333
+ </ td >
334
+ < td >
335
+ < pre class ="code "> < span class ="info file "> # File 'lib/graphql/analysis/field_usage.rb', line 26</ span >
336
+
337
+ < span class ='kw '> def</ span > < span class ='id identifier rubyid_result '> result</ span >
338
+ < span class ='lbrace '> {</ span >
339
+ < span class ='label '> used_fields:</ span > < span class ='ivar '> @used_fields</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_to_a '> to_a</ span > < span class ='comma '> ,</ span >
340
+ < span class ='label '> used_deprecated_fields:</ span > < span class ='ivar '> @used_deprecated_fields</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_to_a '> to_a</ span > < span class ='comma '> ,</ span >
341
+ < span class ='label '> used_deprecated_arguments:</ span > < span class ='ivar '> @used_deprecated_arguments</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_to_a '> to_a</ span > < span class ='comma '> ,</ span >
342
+ < span class ='label '> used_deprecated_enum_values:</ span > < span class ='ivar '> @used_deprecated_enum_values</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_to_a '> to_a</ span > < span class ='comma '> ,</ span >
343
+ < span class ='rbrace '> }</ span >
344
+ < span class ='kw '> end</ span > </ pre >
345
+ </ td >
346
+ </ tr >
347
+ </ table >
348
+ </ div >
349
+
350
+ </ div >
351
+
352
+ </ div >
353
+
354
+ < div id ="footer ">
355
+ Generated on Tue Apr 8 10:47:58 2025 by
356
+ < a href ="https://yardoc.org " title ="Yay! A Ruby Documentation Tool " target ="_parent "> yard</ a >
357
+ 0.9.37 (ruby-3.2.8).
358
+ </ div >
359
+
360
+ </ div >
361
+ </ body >
362
+ </ html >
0 commit comments