getCsvDelimiterValue()

Home > @gooddata/sdk-model > getCsvDelimiterValue

getCsvDelimiterValue() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the actual delimiter character for a given preset selection.

When the preset is "custom", the provided custom delimiter string is returned as-is. When the preset is "inherit", undefined is returned so the delimiter field is omitted from the saved settings, letting the backend-resolved default (workspace or organization setting) apply instead.

Signature:

export declare function getCsvDelimiterValue(selectedPreset: CsvDelimiterPreset, customDelimiter: string): string | undefined;

Parameters

Parameter	Type	Description
selectedPreset	CsvDelimiterPreset	the selected preset identifier
customDelimiter	string	the user-provided custom delimiter (used only when preset is "custom")

Returns:

string | undefined

the resolved delimiter character, or undefined when the preset is "inherit"