Skip to content

ENT-8193: Added docs entry for validfiledata #3748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
victormlg wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ENT-8193: Added docs entry for validfiledata #3748

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions content/reference/functions/validfiledata.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: default
title: validfiledata
aliases:
- "/reference-functions-validfiledata.html"
---

{{< CFEngine_function_prototype(filename, filetype) >}}

**Description:** Parses CSV, JSON, or YAML data from file `filename`
and returns `true` if the content is valid and `false` otherwise.

When `filetype` is `auto`, the file type is guessed from the extension
(ignoring case): `.csv` means CSV; `.json` means JSON; `.yaml` or `.yml` means
YAML. If the file doesn't match any of those names, JSON is used.

{{< CFEngine_function_attributes(filename, filetype) >}}

**Example:**

```cf3
bundle agent main
{
vars:
"content"
data => readdata("/tmp/a.json", "auto"),
if => validfiledata("/tmp/a.json", "auto");
}
```

**See also:** [`data_expand()`][data_expand], `readdata()`, `readcsv()`, `readyaml()`, `readjson()`, `readenvfile()`, `validdata()`, `data` documentation.

**History:** Was introduced in 3.29.0.
Loading