Skip to main content

ReportParameterParams

@gravity-rail/sdk

@gravity-rail/sdk / ReportParameterParams

Interface: ReportParameterParams

One value the model may supply to a report.

Properties​

default?​

optional default: string | number | boolean | null

Value used when the model supplies none. Without it the parameter is required.

description?​

optional description: string

What the value means, for the model (up to 200 characters)

Max Length​

200

maximum?​

optional maximum: number | null

Highest accepted value (integer and number only)

minimum?​

optional minimum: number | null

Lowest accepted value (integer and number only)

name​

name: string

Parameter name: lowercase letters, digits and underscores, up to 40 characters

Pattern​

^[a-z][a-z0-9_]{0,39}$

type​

type: ReportParameterParamsType

Value type