Skip to main content

@terascope/data-mate / teal-frame/export-json / JsonExportOptions

Interface: JsonExportOptions

Defined in: data-mate/src/teal-frame/export-json.ts:66

How an export renders fields and nulls: DataFrame's SerializeOptions, with the same meaning, plus removeNullFields as a shorthand for two common presets. See resolveRules.

Extends​

Properties​

PropertyTypeDescriptionInherited fromDefined in
removeNullFields?booleanSelects a preset: true omits null fields and empty objects, false writes null fields as null. Explicit SerializeOptions flags override the preset.-data-mate/src/teal-frame/export-json.ts:71
skipDuplicateObjects?booleanRemove duplicate objects in a list vectorSerializeOptions.skipDuplicateObjectsdata-mate/src/vector/interfaces.ts:110
skipEmptyArrays?booleanDon't return any empty List or Tuple valuesSerializeOptions.skipEmptyArraysdata-mate/src/vector/interfaces.ts:89
skipEmptyObjects?booleanRemove objects with propertiesSerializeOptions.skipEmptyObjectsdata-mate/src/vector/interfaces.ts:105
skipNilListValues?booleanDon't return any values that are null/undefinedSerializeOptions.skipNilListValuesdata-mate/src/vector/interfaces.ts:94
skipNilObjectValues?booleanDon't return any object values in list that are null/undefined. This will have no change in behavior if skipNilListValues is trueSerializeOptions.skipNilObjectValuesdata-mate/src/vector/interfaces.ts:100
skipNilValues?booleanDon't return any values that are null/undefined. This does not apply to list or tuples, use skipNilListValues or skipNilObjectValues instead.SerializeOptions.skipNilValuesdata-mate/src/vector/interfaces.ts:84
useNullForUndefined?booleanUse a null values in-place of undefined so it can preserved when calling JSON.stringifySerializeOptions.useNullForUndefineddata-mate/src/vector/interfaces.ts:77