ISerializeOptions
Defined in: src/types/ISaveResult.ts:36
Options for Configuard.serializeFlat().
Properties
Section titled “Properties”diffOnly?
Section titled “diffOnly?”
optionaldiffOnly?:boolean
Defined in: src/types/ISaveResult.ts:42
When true (default), only the diff (updates) is returned. Set to
false to also receive the full merged rows for the changed items.
Default
Section titled “Default”trueencrypt?
Section titled “encrypt?”
optionalencrypt?: (value,item) =>string
Defined in: src/types/ISaveResult.ts:53
Hook to encrypt the serialized value of items marked encrypt: true,
applied when their value is edited. Configuard is crypto-agnostic: you
supply how to encrypt. The function must be synchronous.
Parameters
Section titled “Parameters”string
The serialized (plaintext) string value.
Readonly<IConfigItem>
A read-only view of the (merged) config item.
Returns
Section titled “Returns”string
The encrypted string to store.