Skip to content
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

Jump to bottom

Document builtin booleans #116

Merged
merged 1 commit into from
Jan 24, 2024
Merged

Document builtin booleans #116

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
14 changes: 13 additions & 1 deletion doc/YAML/XS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,19 @@ Only `Load` and `Dump` are exported by default.

* `$YAML::XS::Boolean` (since v0.67)

Default is undef.
Default: undef

When used with perl 5.36 or later, builtin booleans will work out of the
box. They will be created by `Load` and recognized by `Dump` automatically
(since YAML::XS 0.89).

```perl
say Dump({ truth => builtin::true });
# truth: true
```

For older perl versions you can use the following configuration to serialize
data as YAML booleans:

When set to `"JSON::PP"` or `"boolean"`, the plain (unquoted) strings `true`
and `false` will be loaded as `JSON::PP::Boolean` or `boolean.pm` objects.
Expand Down
Loading