dnscontrol/documentation/functions/global/require_glob.md
2023-09-14 10:25:45 -04:00

52 lines
1.3 KiB
Markdown

---
name: require_glob
parameters:
- path
- recursive
parameter_types:
path: string
recursive: boolean
---
`require_glob()` recursively loads `.js` files that match a glob (wildcard). The recursion can be disabled.
Possible parameters are:
- Path as string, where you would like to start including files. Mandatory. Pattern matching possible, see [GoLand path/filepath/#Match docs](https://golang.org/pkg/path/filepath/#Match).
- If being recursive. This is a boolean if the search should be recursive or not. Define either `true` or `false`. Default is `true`.
Example to load `.js` files recursively:
{% code title="dnsconfig.js" %}
```javascript
require_glob("./domains/");
```
{% endcode %}
Example to load `.js` files only in `domains/`:
{% code title="dnsconfig.js" %}
```javascript
require_glob("./domains/", false);
```
{% endcode %}
# Comparison to require()
`require_glob()` and `require()` both use the same rules for determining which directory path is
relative to.
This will load files being present underneath `./domains/user1/` and **NOT** at below `./domains/`, as `require_glob()`
is called in the subfolder `domains/`.
{% code title="dnsconfig.js" %}
```javascript
require("domains/index.js");
```
{% endcode %}
{% code title="domains/index.js" %}
```javascript
require_glob("./user1/");
```
{% endcode %}