dnscontrol/documentation/functions/global/require_glob.md
Jeffrey Cafferata 45ad35e68a
DOCS: [GitBook] Code block caption (#1999)
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2023-01-29 13:02:56 -05:00

1.3 KiB

name parameters parameter_types
require_glob
path
recursive
path recursive
string 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.
  • 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:

require_glob("./domains/");

Example to load .js files only in domains/:

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:

{% code title="dnsconfig.js" %}

require("domains/index.js");

{% endcode %}

{% code title="domains/index.js" %}

require_glob("./user1/");

{% endcode %}

This will now load files being present underneath ./domains/user1/ and NOT at below ./domains/, as require_glob() is called in the subfolder domains/.