dnscontrol/documentation/functions/global/require_glob.md
2023-01-20 07:56:20 -05:00

46 lines
1.2 KiB
Markdown

---
name: require_glob
parameters:
- path
- recursive
parameter_types:
path: string
recursive: boolean
---
`require_glob()` can recursively load `.js` files, optionally non-recursive as well.
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:
```javascript
require_glob("./domains/");
```
Example to load `.js` files only in `domains/`:
```javascript
require_glob("./domains/", false);
```
One more important thing to note: `require_glob()` is as smart as `require()` is. It loads files always relative to the JavaScript
file where it's being executed in. Let's go with an example, as it describes it better:
`dnscontrol.js`:
```javascript
require("domains/index.js");
```
`domains/index.js`:
```javascript
require_glob("./user1/");
```
This will now load files being present underneath `./domains/user1/` and **NOT** at below `./domains/`, as `require_glob()`
is called in the subfolder `domains/`.