SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Interface ViewParamDefinition

    Describes a parameter to be passed along with a view intent.

    interface ViewParamDefinition {
        transient?: boolean;
        [property: string]: any;
    }

    Hierarchy

    • ParamDefinition
      • ViewParamDefinition

    Indexable

    • [property: string]: any
    Index

    Properties

    Properties

    transient?: boolean

    Controls how the workbench router should pass this parameter to the workbench view.

    By default, parameters are passed via the workbench URL as matrix parameters. Marking a parameter as "transient" instructs the router to pass it via navigational state, useful for large objects.

    Transient parameters are not persistent, they are only added to the browser's session history to support back/forward browser navigation. Microfrontends must be able to restore state without relying on transient parameters.