SCION Microfrontend Platform - v2.0.0
    Preparing search index...

    Interface ParamDefinition

    Describes a parameter to be passed along with an intent.

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

    Indexable

    • [property: string]: unknown

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

    Index

    Properties

    default?: unknown

    Defines a default value. Only applies to optional parameters.

    The default value is used when the parameter is not provided.

    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.

    description?: string

    Describes the parameter and its usage in more detail.

    name: string

    Specifies the name of the parameter.

    required: boolean

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