114 |
115 |
116 |
117 |
118 |
119 | class
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 | CodeGovAPIClient
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 | new CodeGovAPIClient()
147 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 | functions
181 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 |
198 | getAgencies
199 |
200 |
201 |
202 |
203 |
204 |
205 | This function gets all the agencies on code.gov
206 |
207 |
208 | getAgencies
209 |
210 |
211 |
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 | Returns
226 | Object
:
227 | array of agencies
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 | Example
237 |
238 |
239 | client.getAgencies().then(agencies => {
240 | let count = agencies.length;
241 | console.log("There are " + count + " agencies on code.gov");
242 | });
243 |
244 |
245 |
246 |
247 |
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 | getAgencyRepos
263 |
264 |
265 |
266 |
267 |
268 |
269 | This function gets all the repositories
270 | by a specified agency that are licensed under
271 | open-source or government wide reuse.
272 | It is used to explore on code.gov.
273 |
274 |
275 | getAgencyRepos
276 |
277 |
278 |
279 |
280 |
281 |
282 |
283 |
284 |
285 |
286 |
287 | Parameters
288 |
289 |
290 |
291 |
292 |
agency_id (string)
293 | the agency acronymn
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
size (number
302 | = 10
)
303 | the number of search results to return
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 | Returns
317 | Object
:
318 | array of repositories
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | Example
328 |
329 |
330 | client.getAgencyRepos("SSA").then(repositories => {
331 | console.log("Social Security Agency has these repositories ", repositories);
332 | });
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 | getRepoByID
353 |
354 |
355 |
356 |
357 |
358 |
359 | This function gets a repository by its id
360 | It is used on the project details page of code.gov.
361 |
362 |
363 | getRepoByID
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 | Parameters
376 |
377 |
378 |
379 |
380 |
repo_id (string)
381 | the agency acronymn
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 |
393 |
394 | Returns
395 | Object
:
396 | repository - object that holds information about repo
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
405 | Example
406 |
407 |
408 | let repo_id = "nasa_dfrc_dthdata_armstrong_time_history_software_utility";
409 | client.getRepoByID(repo_id).then(repository => {
410 | console.log("Repository information is ", repository);
411 | });
412 |
413 |
414 |
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 | search
432 |
433 |
434 |
435 |
436 |
437 |
438 | This function searches all of the repositories
439 | based on a string of text.
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 |
450 |
451 |
452 |
453 |
454 | Parameters
455 |
456 |
457 |
458 |
459 |
text (string)
460 | the text to search by
461 |
462 |
463 |
464 |
465 |
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 | Returns
474 | Object
:
475 | array of search result repos
476 | client.search("services").then(repos => {
477 | console.log("Repos related to services are", repos);
478 | });
479 |
480 |
481 |
482 |
483 |
484 |
485 |
486 |
487 |
488 |
489 |
490 |
491 |
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 | suggest
505 |
506 |
507 |
508 |
509 |
510 |
511 | The suggest function takes in a search term then
512 | returns auto-complete / type-ahead suggestions.
513 | It is used by the search boxes on code.gov.
514 |
515 |
516 |
517 |
518 |
519 |
520 |
521 |
522 |
523 |
524 |
525 |
526 |
527 |
528 | Parameters
529 |
530 |
531 |
532 |
533 |
term (string)
534 | the term to search by
535 |
536 |
537 |
538 |
539 |
540 |
541 |
542 |
size (number
543 | = 10
)
544 | the number of search results to return
545 |
546 |
547 |
548 |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 |
557 | Returns
558 | Object
:
559 | array of search result objects
560 |
561 |
562 |
563 |
564 |
565 |
566 |
567 |
568 | Example
569 |
570 |
571 | client.suggest("space").then(terms => {
572 | console.log("Terms that are related to space", terms);
573 | });
574 |
575 |
576 |
577 |
578 |
579 |
580 |
581 |
582 |
583 |
584 |
585 |
586 |