Package io.github.cdklabs.projen

Interface ObjectFileOptions

All Superinterfaces:

FileBaseOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IniFileOptions, JsonFileOptions, TomlFileOptions, XmlFileOptions, YamlFileOptions

All Known Implementing Classes:

IniFileOptions.Jsii$Proxy, JsonFileOptions.Jsii$Proxy, ObjectFileOptions.Jsii$Proxy, TomlFileOptions.Jsii$Proxy, XmlFileOptions.Jsii$Proxy, YamlFileOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.780Z")
@Stability(Experimental)
public interface ObjectFileOptions
extends software.amazon.jsii.JsiiSerializable, FileBaseOptions

(experimental) Options for ObjectFile.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObjectFileOptions.Builder	A builder for ObjectFileOptions
static class	ObjectFileOptions.Jsii$Proxy	An implementation for ObjectFileOptions

Method Summary

Modifier and Type	Method	Description
static ObjectFileOptions.Builder	builder()
default Object	getObj()	(experimental) The object that will be serialized.
default Boolean	getOmitEmpty()	(experimental) Omits empty objects and arrays.

Methods inherited from interface io.github.cdklabs.projen.FileBaseOptions

getCommitted, getEditGitignore, getExecutable, getMarker, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getObj

@Stability(Experimental)
@Nullable
default Object getObj()

(experimental) The object that will be serialized. You can modify the object's contents before synthesis.

Serialization of the object is similar to JSON.stringify with few enhancements:

• values that are functions will be called during synthesis and the result will be serialized - this allow to have lazy values.
• Set will be converted to array
• Map will be converted to a plain object ({ key: value, ... }})
• RegExp without flags will be converted to string representation of the source

Default: {} an empty object (use `file.obj` to mutate).

getOmitEmpty

@Stability(Experimental)
@Nullable
default Boolean getOmitEmpty()

(experimental) Omits empty objects and arrays.

Default: false

builder

@Stability(Experimental)
static ObjectFileOptions.Builder builder()

Returns:

a ObjectFileOptions.Builder of ObjectFileOptions