json5k/io.github.xn32.json5k/ConfigBuilder

ConfigBuilder

class ConfigBuilder(source)

Type-safe builder to configure the parameters of a custom Json5 instance.

Constructors

ConfigBuilder

constructor()

Properties

classDiscriminator

var classDiscriminator: String

Class discriminator to use for the serialization and deserialization of polymorphic types. This setting defaults to type and can be overwritten on a per-class basis using the ClassDiscriminator annotation.

encodeDefaults

var encodeDefaults: Boolean

Encode default values from the data model when the object hierarchy to serialize does not overwrite them.

indentationWidth

var indentationWidth: Int

Number of spaces to use for indenting each hierarchy level (objects/arrays) in generated JSON5 output. This setting has an effect only if the prettyPrint option is activated.

prettyPrint

var prettyPrint: Boolean

Request the generation of human-readable output (spanning multiple lines). Without this option, compressed single-line output is generated. SerialComment annotations are ignored without this setting.

quoteMemberNames

var quoteMemberNames: Boolean

Request names of serialized object members to be quoted even if the quotation marks could be dropped. This setting has an effect only if the prettyPrint option is activated. If compressed single-line output is generated, member names will be quoted only when necessary.

serializersModule

var serializersModule: SerializersModule?

Supply a custom SerializersModule that will be passed to the kotlinx.serialization framework.

useSingleQuotes

var useSingleQuotes: Boolean

Use single quotes instead of double quotes when serializing strings and member names in human-readable output. This setting has an effect only if the prettyPrint option is activated. If compressed single-line output is generated, double quotes will be used.