Class AbstractConfigurationAbstract

Contains the configurations shared with all patterns.

Export

Abstract

Hierarchy-Diagram

UML class diagram of AbstractConfiguration
Legend
icon for a class in the UML class diagram class
icon for an abstract class in the UML class diagram abstract class
icon for a public property in the UML class diagram public property
icon for a private property in the UML class diagram private property
icon for a public method in the UML class diagram public method
icon for a protected method in the UML class diagram protected method
italic abstract property/method

Hierarchy

Properties

ExtendedClass

Constructors

constructor

Methods

validateBoolean validateDate validateInRange validateNumber validateString validateTime validateCanChange validateDefault

Properties

ExtendedClass

ExtendedClass: string

Constructors

constructor

Methods

Protected validateBoolean

  • Protected

    Method that helps to validate if a boolean is not undefined

    Returns

    {boolean}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: boolean
    • defaultValue: boolean

    Returns boolean

Protected validateDate

  • Protected

    Method that helps to validate if a given value is a valid date

    Returns

    {(string | Date)}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: string | Date
    • defaultValue: string

    Returns string | Date

Protected validateInRange

  • Protected

    Method that helps to validate if a given value is within a range of values.

    Returns

    {unknown}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: unknown
    • defaultValue: unknown
    • Rest ...args: unknown[]

    Returns unknown

Protected validateNumber

  • Protected

    Method that helps to validate if a number is not empty or undefined.

    Returns

    {number}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: number
    • defaultValue: number

    Returns number

Protected validateString

  • Protected

    Method that helps to validate if a string is not empty or undefined.

    Returns

    {string}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: string
    • defaultValue: string

    Returns string

Protected validateTime

  • Protected

    Method that helps to validate if a given value is a valid time

    Returns

    {(string)}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • value: string
    • defaultValue: string

    Returns string

validateCanChange

  • Method that validates if a given property can be changed.

    Returns

    {boolean}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • _isBuilt: boolean
    • _key: string

    Returns boolean

validateDefault

  • Method that assures that the values being set as configurations respect the defaults.

    Returns

    {unknown}

    Memberof

    OSFramework.Patterns.AbstractConfiguration

    Parameters

    • _key: string
    • value: unknown

    Returns unknown

Settings

Member Visibility

Theme