Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "settings"

Store for the various settings that are supported in the UI framework, details on the available settings can be found here: https://github.com/manywho/ui-html5/wiki/Settings

Index

Functions

Functions

Const event

  • event(path: string): any

  • Get an event specific setting

    Parameters

    • path: string

      The nested path of the event specific setting to retrieve e.g. invoke.done

    Returns any

Const flow

  • flow(path: string, flowKey: string): any

  • Get a flow specific setting

    Parameters

    • path: string

      The nested path of the flow specific setting to retrieve e.g. formatting.isEnabled

    • flowKey: string

    Returns any

Const global

  • global(path: string, flowKey?: string, defaultValue?: any): any

  • Get the value of a specific setting. Checks global settings first, then flow specific settings (if the flowKey parameter is specified)

    Parameters

    • path: string

      The nested path of the flow specific setting to retrieve e.g. formatting.isEnabled

    • Optional flowKey: string
    • Optional defaultValue: any

      Value to return if no matching setting can be found

    Returns any

Const initialize

  • initialize(custom?: any, handlers?: any): void

  • Initialize the default settings and provide any custom settings or overrides

    Parameters

    • Optional custom: any

      Custom settings to append to or override the default settings

    • Optional handlers: any

      Custom event handlers to append to or override the default event handlers

    Returns void

Const initializeFlow

  • initializeFlow(settings: any, flowKey: string): void

  • Intialize settings for a specific flow and provide and custom settings or overrides

    Parameters

    • settings: any

      Custom settings that are specific to this flow execution (based on the flowKey)

    • flowKey: string

    Returns void

Const isDebugEnabled

  • isDebugEnabled(flowKey: string, value?: boolean): boolean

  • Returns true if the execution mode of the flow is set to DEBUG or DEBUG_STEPTHROUGH. Set the value parameter to true to enable debug mode

    Parameters

    • flowKey: string
    • Optional value: boolean

      True to set the debug mode to "DEBUG"

    Returns boolean

Const remove

  • remove(flowKey: string): void

  • Removes custom flow settings based on the flowkey

    Parameters

    • flowKey: string

    Returns void

Const theme

  • theme(path: string): any

  • Get a theme specific setting

    Parameters

    • path: string

      The nested path of the theme specific setting to retrieve

    Returns any

Generated using TypeDoc