@mendix/extensions-api - v0.15.1
    Preparing search index...

    Interface ICommandLineArgumentsApi

    API interface for retrieval the information about the feature flags of Studio Pro.

    interface ICommandLineArgumentsApi {
        _apiId: "mendix.FeatureFlagApi";
        addEventListener<K extends never>(
            eventType: K,
            listener: EventHandler<{}, K>,
        ): DisposeListener;
        isCommandLineFlagProvided(featureFlagName: string): Promise<boolean>;
        removeEventListener<K extends never>(
            eventType: K,
            listener: EventHandler<{}, K>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _apiId: "mendix.FeatureFlagApi"

    Unique identifier for the Feature Flag API.

    Methods

    • Adds an event listener for the specified event type.

      Type Parameters

      • K extends never

      Parameters

      • eventType: K

        The type of event to listen for.

      • listener: EventHandler<{}, K>

        The event listener to add.

      Returns DisposeListener

      A function that can be called to remove the event listener.

    • Checks if the flag provided, was passed to Studio Pro in the command line

      Parameters

      • featureFlagName: string

      Returns Promise<boolean>

    • Removes an event listener for the specified event type.

      Type Parameters

      • K extends never

      Parameters

      • eventType: K

        The type of event to remove the listener from.

      • listener: EventHandler<{}, K>

        The event listener to remove.

      Returns void