You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 1, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+47-46Lines changed: 47 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,14 @@ A valid OpenAttestation DNS-TXT record looks like:
17
17
18
18
Validation is run on all retrieved records to ensure they conform to the expected format, and records that fail validation will simply be omitted from the returned results.
19
19
20
-
21
20
To see validation failures run the library with the debug flag turned on, either
22
21
23
22
In Browser:
24
23
25
24
`localStorage.debug="dnsprove*"`
26
25
27
26
In NodeJS:
27
+
28
28
```sh
29
29
DEBUG="dnsprove*" npm run test
30
30
```
@@ -33,90 +33,83 @@ DEBUG="dnsprove*" npm run test
33
33
34
34
This library uses [runtypes](https://github.com/pelotom/runtypes) for compile time static type checking as well as run time input validation. The generated documentation below is inaccurate for any Runtypes generated types due to documentation generator limitations.
35
35
36
-
37
36
## API
38
37
39
38
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Returns true if the given object passes runtype validation for OpenAttestationDNSTextRecord
97
-
Turn on debug log to see exact validation failure messages if necessary
88
+
Takes a DNS-TXT Record set and returns openattestation document store records if any
98
89
99
90
#### Parameters
100
91
101
-
-`record`**[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)** An object that may conform to the OpenAttestationDNSTextRecord shape
92
+
*`recordSet`**[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
Takes a DNS-TXT Record set and returns openattestation document store records if any
97
+
### parseDnsDidResults
106
98
107
99
#### Parameters
108
100
109
-
-`recordSet`**[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
0 commit comments