Class ConfigHelper

Description

Helper class for configuring Firemitt and Fireguard settings.

This class provides static methods to construct and validate configuration objects for Firemitt and Fireguard. It handles dimensions, positions, URLs, and Fireguard specific configurations including theme and Firebase settings.

Constructors

constructor

Methods

getDim getFireguardConfig getFlags getPos getURL init

Constructors

constructor

Methods

Static Private getDim

  • getDim(width, height): TDim

  • Parameters

    • width: TUnsafe<number>

      Potentially undefined or null width value.

    • height: TUnsafe<number>

      Potentially undefined or null height value.

    Returns TDim

    The dimensions object with width and height.

    Description

    Creates a TDim object representing dimensions, ensuring valid numeric values.

    Static

Static Private getFireguardConfig

  • getFireguardConfig(config, fallbackTheme?): TFireguardConfig

  • Parameters

    • config: TUnsafe<Partial<TFireguardOptions>>

      The potentially undefined or null Fireguard configuration options.

    • Optional fallbackTheme: Partial<TTheme>

      Optional fallback theme settings.

    Returns TFireguardConfig

    The constructed Fireguard configuration object.

    Description

    Creates a TFireguardConfig object from partial options, with fallbacks for theme and Firebase configurations.

    Static

    Throws

    If the application name is invalid.

    Throws

    If the Firebase configuration is invalid.

Static getFlags

  • getFlags(config): string

  • Parameters

    Returns string

    A string of window feature flags for use in window.open.

    Description

    Constructs a string representing window features (flags) for window.open based on the given Firemitt configuration.

    Static

Static Private getPos

  • getPos(x, y, width): TPos

  • Parameters

    • x: TUnsafe<number>

      Potentially undefined or null x-coordinate.

    • y: TUnsafe<number>

      Potentially undefined or null y-coordinate.

    • width: number

      The width of the element, used to calculate default x-coordinate.

    Returns TPos

    The position object with x and y coordinates.

    Description

    Generates a TPos object representing the position, using default values if necessary.

    Static

Static Private getURL

  • getURL(url): string

  • Parameters

    • url: TUnsafe<string>

      The potentially undefined or null URL.

    Returns string

    The validated URL string.

    Description

    Validates and returns a URL string, throwing an error if invalid.

    Static

    Throws

    If the URL is invalid.

Static init

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc