Class LowercaseStringFormatter

For LookupKey.Lowercase. Converts all characters to lowercase. Uses the Javascript toLocaleLowerCase(cultureId) function

Hierarchy (view full)

DataTypeFormatterBase
- LowercaseStringFormatter

Index

Constructors

Accessors

services hasServices expectedLookupKeys

Methods

dispose supports prepString matchingLookupKeys supportsCulture format

Constructors

constructor

new LowercaseStringFormatter(): LowercaseStringFormatter
Returns LowercaseStringFormatter
Inherited from DataTypeFormatterBase.constructor

Accessors

services

get services(): IValidationServices
Services accessor. Note: Not passed into the constructor because this object should be created before ValidationServices itself. So it gets assigned when ValidationService.dataTypeFormatterService is assigned a value.

Returns IValidationServices
Inherited from DataTypeFormatterBase.services
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:39
set services(services): void
Provides access to services.
Parameters
- services: IValidationServices
Returns void
Inherited from DataTypeFormatterBase.services
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:44

`Protected` hasServices

get hasServices(): boolean
Returns boolean
Inherited from DataTypeFormatterBase.hasServices
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:49

`Protected` expectedLookupKeys

get expectedLookupKeys(): string | string[]
The DataTypeLookup key(s) that this class supports.

Returns string | string[]
Overrides DataTypeFormatterBase.expectedLookupKeys
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:202

Methods

dispose

dispose(): void
Participates in releasing memory. While not required, the idea is to be a more friendly participant in the ecosystem. Note that once called, expect null reference errors to be thrown if any other functions try to use them.

Returns void
Inherited from DataTypeFormatterBase.dispose
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:30

supports

supports(dataTypeLookupKey, cultureId): boolean
Evaluates the parameters to determine if its format() method should handle the value with those same parameters. It should always match the DataTypeLookupKey. It does not have to evaluate the cultureID, as there are implementations where the format() function handles eve
Parameters
- dataTypeLookupKey: string
- cultureId: string
  Such as 'en-US' and 'en'
Returns boolean
Use its format() method when true. Do not use format() when false.
Inherited from DataTypeFormatterBase.supports
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:75

`Protected` prepString

prepString(value): DataTypeResolution<string>
Parameters
- value: any
Returns DataTypeResolution<string>
Inherited from DataTypeFormatterBase.prepString
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:89

`Protected` matchingLookupKeys

matchingLookupKeys(luk1, luk2): boolean
LookupKeys must be case insensitive matched.
Parameters
- luk1: string
- luk2: string | string[]
Returns boolean
Inherited from DataTypeFormatterBase.matchingLookupKeys
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:106

`Protected` supportsCulture

supportsCulture(cultureId): boolean
Return true so long as the CultureId is supported by this class.
Parameters
- cultureId: string
Returns boolean
Overrides DataTypeFormatterBase.supportsCulture
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:207

format

format(value, dataTypeLookupKey, cultureId): DataTypeResolution<string>
Creates a formatted string for the value, applying the goals of the DataTypeLookupKey and making it culture specific.
Parameters
- value: any
- dataTypeLookupKey: string
- cultureId: string
Returns DataTypeResolution<string>
Overrides DataTypeFormatterBase.format
- Defined in packages/jivs-engine/src/DataTypes/DataTypeFormatters.ts:212

Generated using TypeDoc v0.25.12