Browse Source

checks pass

boB Rudis 10 months ago
parent
commit
e923d22cab
No known key found for this signature in database
4 changed files with 16 additions and 5 deletions
  1. 1
    0
      .Rbuildignore
  2. 6
    3
      R/resolver.R
  3. 8
    1
      man/gdns_query.Rd
  4. 1
    1
      man/gdns_resolver.Rd

+ 1
- 0
.Rbuildignore View File

@@ -13,3 +13,4 @@
13 13
 ^tmp$
14 14
 ^notes$
15 15
 ^\.gitlab-ci\.yml$
16
+^CONDUCT\.md$

+ 6
- 3
R/resolver.R View File

@@ -1,7 +1,7 @@
1 1
 #' Create a gdns DNS over TLS context and populate it with a resolver
2 2
 #' for use in resolution functions
3 3
 #'
4
-#' @param resolver character vector of valid DNS over TLS resolvers;
4
+#' @param resolvers character vector of valid DNS over TLS resolvers;
5 5
 #'        Defaults to Quad9 (`9.9.9.9`).
6 6
 #' @export
7 7
 #' @examples
@@ -109,15 +109,18 @@ gdns_resolver <- function(resolvers = "9.9.9.9") {
109 109
 #' - `x25`
110 110
 #' - `zonemd`
111 111
 #'
112
+#' @param gctx gdns resolver context created with [gdns_resolver()]
113
+#' @param name an entity to query for
114
+#' @param rr_type what resource record type do you want to queyr for? See `Details`.
112 115
 #' @references <https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml>
113 116
 #' @export
114 117
 #' @examples
115 118
 #' x <- gdns_resolver()
116 119
 #' gdns_query(x, "example.com")
117
-gdns_query <- function(gcx, name, rr_type = "txt") {
120
+gdns_query <- function(gctx, name, rr_type = "txt") {
118 121
 
119 122
   rr_type <- match.arg(trimws(tolower(rr_type[1])), names(rr_types))
120
-  res <- int_gdns_query(gcx, name, unname(as.integer(rr_types[rr_type])))
123
+  res <- int_gdns_query(gctx, name, unname(as.integer(rr_types[rr_type])))
121 124
   if (length(res)) {
122 125
     out <- jsonlite::fromJSON(res)
123 126
     out

+ 8
- 1
man/gdns_query.Rd View File

@@ -4,7 +4,14 @@
4 4
 \alias{gdns_query}
5 5
 \title{Arbitrary DNS queries}
6 6
 \usage{
7
-gdns_query(gcx, name, rr_type = "txt")
7
+gdns_query(gctx, name, rr_type = "txt")
8
+}
9
+\arguments{
10
+\item{gctx}{gdns resolver context created with \code{\link[=gdns_resolver]{gdns_resolver()}}}
11
+
12
+\item{name}{an entity to query for}
13
+
14
+\item{rr_type}{what resource record type do you want to queyr for? See \code{Details}.}
8 15
 }
9 16
 \description{
10 17
 Perform any valid resource record inquiry for a given name. See \code{Details}.

+ 1
- 1
man/gdns_resolver.Rd View File

@@ -8,7 +8,7 @@ for use in resolution functions}
8 8
 gdns_resolver(resolvers = "9.9.9.9")
9 9
 }
10 10
 \arguments{
11
-\item{resolver}{character vector of valid DNS over TLS resolvers;
11
+\item{resolvers}{character vector of valid DNS over TLS resolvers;
12 12
 Defaults to Quad9 (\code{9.9.9.9}).}
13 13
 }
14 14
 \description{

Loading…
Cancel
Save