StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-09-20 06:46:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: TypeScript improvements (#2586)

Browse source 
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Jeffrey Cafferata 2023-10-08 17:35:53 +02:00 committed by GitHub
parent e7f1872fd5
commit f661cd4777
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
documentation/typescript.md
View file

@ -25,9 +25,11 @@ dnscontrol write-types
This file has all the information your editor or IDE needs. It must be in the same directory as the `dnsconfig.js` file you are editing.
NOTE: Re-run the `dnscontrol write-types` command any time you upgrade
{% hint style="info" %}
**NOTE**: Re-run the `dnscontrol write-types` command any time you upgrade
DNSControl. Because it is generated from the command, it will always be correct
for the version of DNSControl you are using.
{% endhint %}
2. Tell your editor
@ -50,15 +52,19 @@ If your editor requires extra steps, please [file a bug](https://github.com/Stac
### Bugs?
**Bugs?** Not all features of DNSControl work perfectly at the moment. Please report bugs and feature requests on https://github.com/StackExchange/dnscontrol/issues
{% hint style="warning" %}
**BUGS**: Not all features of DNSControl work perfectly at the moment. Please report bugs and feature requests on https://github.com/StackExchange/dnscontrol/issues
{% endhint %}
**This is experimental.** This feature is currently experimental. We might change the installation instructions as we find better ways to enable this.
{% hint style="info" %}
**NOTE**: This feature is currently experimental. We might change the installation instructions as we find better ways to enable this.
{% endhint %}
## Known bugs
## Known bugs/issue
## Bug: `CLI_DEFAULTS` not implemented
### Bug: `CLI_DEFAULTS` not implemented
Bug: Values passed to `CLI_DEFAULTS` (and the corresponding `-v` command-line option) don’t show up as global variables
Values passed to `CLI_DEFAULTS` (and the corresponding `-v` command-line option) don’t show up as global variables
Workaround: create a new `.d.ts` file in the same folder as your `dnsconfig.js` file. In that file, add the following line for each variable you want to use (replacing `VARIABLE_NAME` with the name of the variable).
@ -71,7 +77,6 @@ declare const VARIABLE_NAME: string;
This will tell TypeScript that the variable exists, and that it’s a string.
## Known issue: `FETCH` not always accurate
Bug: `FETCH` is always shown as available, even if you don’t run DNSControl with the `--allow-fetch` flag.
### Known issue: `FETCH` not always accurate
`FETCH` is always shown as available, even if you don’t run DNSControl with the `--allow-fetch` flag.