Class AbstractProviderConfiguration`Abstract`

Represents the configurations for a provider. Will have a method to get the configurations in the provider format.

Export

AbstractProviderConfiguration

Hierarchy (View Summary)

AbstractConfiguration
- AbstractProviderConfiguration

Index

Constructors

constructor

new AbstractProviderConfiguration(config: JSON): AbstractProviderConfiguration
Parameters
- config: JSON
Returns AbstractProviderConfiguration
Inherited from AbstractConfiguration.constructor
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:13

Properties

ExtendedClass

ExtendedClass: string

Methods

`Protected`validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:30

`Protected`validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:43

`Protected`validateInRange

validateInRange(
    value: unknown,
    defaultValue: unknown,
    ...args: unknown[],
): unknown
Protected
Method that helps to validate if a given value is within a range of values.
Parameters
- value: unknown
- defaultValue: unknown
- ...args: unknown[]
Returns unknown
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:57

`Protected`validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.
Parameters
- value: number
- defaultValue: number
Returns number
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:79

`Protected`validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.
Parameters
- value: string
- defaultValue: string
Returns string
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:92

`Protected`validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time
Parameters
- value: string
- defaultValue: string
Returns string
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:105

validateCanChange

validateCanChange(_isBuilt: boolean, _key: string): boolean
Method that validates if a given property can be changed.
Parameters
- _isBuilt: boolean
- _key: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:118

validateDefault

validateDefault(_key: string, value: unknown): unknown
Method that assures that the values being set as configurations respect the defaults.
Parameters
- _key: string
- value: unknown
Returns unknown
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateDefault
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:131

`Protected`mergeConfigs

mergeConfigs(
    commonConfigs: any,
    specificConfigs: any,
    extendedConfigs?: any,
): any
Protected
Method to merge Common, Specific and External configs
Parameters
- commonConfigs: any
- specificConfigs: any
- OptionalextendedConfigs: any
Returns any
{ProviderConfigs}

Memberof
OSFramework.Patterns.AbstractProviderConfiguration
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:23

`Abstract`getProviderConfig

getProviderConfig(): any
Returns any
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:54

Class AbstractProviderConfigurationAbstract

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AbstractProviderConfiguration

Properties

ExtendedClass

Methods

ProtectedvalidateBoolean

Parameters

Returns boolean

Memberof

ProtectedvalidateDate

Parameters

Returns string | Date

Memberof

ProtectedvalidateInRange

Parameters

Returns unknown

Memberof

ProtectedvalidateNumber

Parameters

Returns number

Memberof

ProtectedvalidateString

Parameters

Returns string

Memberof

ProtectedvalidateTime

Parameters

Returns string

Memberof

validateCanChange

Parameters

Returns boolean

Memberof

validateDefault

Parameters

Returns unknown

Memberof

ProtectedmergeConfigs

Parameters

Returns any

Memberof

AbstractgetProviderConfig

Returns any

Settings

On This Page

Class AbstractProviderConfiguration`Abstract`

`Protected`validateBoolean

`Protected`validateDate

`Protected`validateInRange

`Protected`validateNumber

`Protected`validateString

`Protected`validateTime

`Protected`mergeConfigs

`Abstract`getProviderConfig