Interface ParamDefinition

Describes a parameter to be passed along with an intent.

interface ParamDefinition {
    deprecated?: true | { message?: string; useInstead?: string };
    description?: string;
    name: string;
    required: boolean;
    [property: string]: any;
}

Indexable

  • [property: string]: any

    Allows the declaration of additional metadata that can be interpreted in an interceptor, for example.

Properties

deprecated? description? name required

Properties

Optionaldeprecated

deprecated?: true | { message?: string; useInstead?: string }

Allows deprecating the parameter.

It is good practice to explain the deprecation, provide the date of removal, and how to migrate. If renaming the parameter, you can set the useInstead property to specify which parameter to use instead. At runtime, this will map the parameter to the specified replacement, allowing for straightforward migration on the provider side.

Optionaldescription

description?: string

Describes the parameter and its usage in more detail.

name

name: string

Specifies the name of the parameter.

required

required: boolean

Specifies whether the parameter must be passed along with the intent.

Settings

Member Visibility

On This Page

Properties