Skip to content

Commit 0e7644d

Browse files
committed
removes example: from headings
1 parent fabdb38 commit 0e7644d

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

hugo-gh/content/tutorials/Golang-WASM-SDK.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
+++
2-
title = 'sig0namectl Javascript API Examples'
2+
title = 'sig0namectl API Javascript Examples'
33
date = 2024-06-29T14:17:22+02:00
44
draft = false
55
+++
66

7-
This section documents the sig0namectl API functions exposed to Javascript via WebAssembly (WASM).
7+
This section documents usage of the sig0namectl API functions exposed to Javascript via WebAssembly (WASM). It is intended to assist further innovative development of browser-based sig0 dynamic update DNS applications.
88

9-
## Example: newKeyRequest(): new domain key request
9+
## newKeyRequest(): new domain key request
1010
```
1111
// note: needed in browser console debugging eg. after page reload
1212
const newKeyReq = goFuncs["newKeyRequest"]
@@ -21,7 +21,7 @@ newKeyReq(newName, "doh.zenr.io").then(() => {
2121
}).catch(err => alert(err.message))
2222
```
2323

24-
## Example: listKeys(): list all keypairs in keystore
24+
## listKeys(): list all keypairs in keystore
2525
```
2626
// arguments: 0
2727
// returns an array of all current keystore keys as JSON objects
@@ -54,7 +54,7 @@ function listKeys() {
5454
}
5555
```
5656

57-
## Example: listKeysFiltered(): list keys in keystore to update a given FQDN
57+
## listKeysFiltered(): list keys in keystore to update a given FQDN
5858
```
5959
// arguments: 1
6060
// 1 argument:
@@ -97,7 +97,7 @@ function getKeysForDomain() {
9797
9898
```
9999

100-
## Example: checkKeyStatus(): check DNS status of keypairs in keystore
100+
## checkKeyStatus(): check DNS status of keypairs in keystore
101101

102102
```
103103
async function listKeysWithStatus() {
@@ -122,7 +122,7 @@ async function listKeysWithStatus() {
122122
return
123123
}
124124
```
125-
## Example: query(): submit DNS query
125+
## query(): submit DNS query
126126

127127
```
128128
// arguments: 1 to 3 (2 optional)
@@ -139,7 +139,7 @@ q("zenr.io", {type: "AAAA", dohurl: "doh.zenr.io"})
139139
q({domain: "zenr.io", type: "AAAA", dohurl: "doh.zenr.io"})
140140
```
141141

142-
## Example: newUpdater(): submit DNS update request
142+
## newUpdater(): submit DNS update request
143143
```
144144
// note: needed in browser console debugging eg. after page reload
145145
const newUpdater = goFuncs["newUpdater"]
@@ -174,7 +174,7 @@ u.deleteRRset("update1.wasm-wrapped2.zenr.io 300 IN A")
174174
u.signedUpdate().then(ok => console.log(`okay! ${ok}`)).catch(err => alert(err.message))
175175
```
176176

177-
## Example: findDOHEndpoint(): find DOH URL for a given domain name
177+
## findDOHEndpoint(): find DOH URL for a given domain name
178178
```
179179
// findDOHEndpoint()
180180
// for a given domain (usually a zone), find DOH Endpoint URL for update returned as string
@@ -205,7 +205,7 @@ async function findDOHEndpoint() {
205205
206206
```
207207

208-
## Example: getDefaultDOHResolver(): get default DNS over HTTPS resolver
208+
## getDefaultDOHResolver(): get default DNS over HTTPS resolver
209209
```
210210
// getDefaultDOHResolver()
211211
// gets current default DOH resolver for WASM API
@@ -215,7 +215,7 @@ async function findDOHEndpoint() {
215215
console.log("Current default DOH resolver is: ", getDefaultDOHResolver())
216216
217217
```
218-
## Example: setDefaultDOHResolver(): set default DNS over HTTPS resolver
218+
## setDefaultDOHResolver(): set default DNS over HTTPS resolver
219219
```
220220
// setDefaultDOHResolver()
221221
// sets default DOH resolver for WASM API

0 commit comments

Comments
 (0)