formatter

Documentation

Index

• type FormatConfig
  • func Format(userRows *gateway.TableData, opts ...FormatOption) ([]byte, FormatConfig, error)
• type FormatOption
  • func WithExtract(extract bool) FormatOption
  • func WithOutput(output Output) FormatOption
  • func WithUnwrap(unwrap bool) FormatOption
• type Output
  • func OutputFromString(o string) (Output, bool)

Types

type FormatConfig

type FormatConfig struct {
	Output  Output
	Unwrap  bool
	Extract bool
}

FormatConfig is the format configuration used.

func Format

func Format(userRows *gateway.TableData, opts ...FormatOption) ([]byte, FormatConfig, error)

Format transforms the user rows according to the provided configuration, retuning raw json or jsonl bytes.

type FormatOption

type FormatOption func(*FormatConfig)

FormatOption controls the behavior of calls to Format.

func WithExtract

func WithExtract(extract bool) FormatOption

WithExtract specifies whether or not to extract the JSON object from the single property of the surrounding JSON object. Default is false.

func WithOutput

func WithOutput(output Output) FormatOption

WithOutput specifies the output format. Default is Table.

func WithUnwrap

func WithUnwrap(unwrap bool) FormatOption

WithUnwrap specifies whether or not to unwrap the returned JSON objects from their surrounding array. Default is false.

type Output

type Output string

Output is used to control the output format of a query specified with the "output" query param.

const (
	// Table returns the query results as a JSON object with columns and rows properties.
	Table Output = "table"
	// Objects returns the query results as a JSON array of JSON objects. This is the default.
	Objects Output = "objects"
)

func OutputFromString

func OutputFromString(o string) (Output, bool)

OutputFromString converts a string into an Output.