andculturecode-javascript-core
- AnchorTargetTypes
- AriaRole
- ConnectionType
- ContentType
- EffectiveConnectionType
- ErrorType
- HttpHeader
- HttpVerb
- NavigatorConnectionVariant
- QueryStringArrayFormat
- UnitOfTime
- Auditable
- Culture
- CultureParams
- DoTryConfig
- Entity
- KeyValuePair
- LocalizationInitOptions
- Navigator
- NetworkConnection
- NetworkInformation
- PagedQuery
- PagedResult
- Result
- ResultError
- Role
- ScrollOptions
- ServiceResponse
- User
- Window
- AsyncWorkload
- CancellablePromise
- CatchResultHandler
- Constructor
- FinallyHandler
- OmitKeys
- RequiredOr
- RequiredOrUndefined
- SyncWorkload
- TimerFunctionReturn
- NetworkInformationUtils
- REGEX_VALID_CULTURE_CODE
- REGEX_VALID_EMAIL
- ResultErrorRecordFactory
- ResultRecordFactory
- VideoResolutions
- _currentCultureCode
- _defaultApiUrl
- _routeParamRegEx
- errorCultureIsRequired
- routeParam
- t
- _configure
- _configureCultureCode
- _configureHeaders
- _configureInterceptors
- _isIE
- _isNotIE
- _mapAxiosResponse
- _mapPagedAxiosResponse
- _scrollToElementById
- _scrollToHash
- appendQueryParams
- buildNetworkInformationUtils
- camelCase
- capitalize
- changeCultureCode
- cultureCodeFromQueryString
- cultureCodeFromRoute
- cultureFactory
- culturesToResources
- currentCultureCode
- defaultCultureCode
- detectCultureCode
- difference
- equalsBy
- filename
- first
- flattenDeep
- getUrl
- getUrlFromPath
- hasValue
- hasValues
- initialize
- intersection
- isAbsoluteUrl
- isDevelopment
- isEmpty
- isNotEmpty
- isValidCultureCode
- isValidEmail
- join
- length
- lowerFirst
- pad
- padEnd
- padStart
- pluralize
- queryStringToObject
- registerPromiseFinallyPolyfill
- removeElementAt
- repeat
- replaceElementAt
- replacePathParams
- runIfDevelopment
- sample
- sampleSize
- snakeCase
- sortByString
- startCase
- take
- template
- translate
- truncateRight
- upperFirst
- words
- AuditableDefaultValues
- BaseEnglishUnitedStates
- BaseSpanishSpain
- BrowserUtils
- CollectionUtils
- CoreUtils
- DefaultScrollOptions
- EmailConstants
- EnvironmentUtils
- FactoryType
- LocalizationUtils
- PolyfillUtils
- PromiseFactory
- RecordUtils
- Rfc4646LanguageCodes
- RouteUtils
- ScrollUtils
- ServiceUtils
- StringUtils
- defaultInitOptions
- defaultValues
- detectionOptions
• __global:
Defined in src/utilities/browser-utils.ts:4
Allows us to use the documentMode for feature detection on globalThis.Document
• Document:
Defined in src/utilities/browser-utils.ts:5
• documentMode? : any
Defined in src/utilities/browser-utils.ts:6
Ƭ AsyncWorkload: function
Defined in src/types/async-workload.ts:4
Represents an asynchronous method reference.
▸ (): Promise‹T›
Ƭ CancellablePromise: object
Defined in src/types/cancellable-promise.ts:1
-
cancel(): function
- (): void
-
promise: Promise‹T›
Ƭ CatchResultHandler: function
Defined in src/types/catch-result-handler.ts:6
Handler for a typed error ResultRecord, or any type if a Javascript error occurred.
▸ (result?: ResultRecord‹T›, error?: any): void
Parameters:
| Name | Type |
|---|---|
result? |
ResultRecord‹T› |
error? |
any |
Ƭ Constructor: object
Defined in src/types/constructor.ts:4
Represents the constructor of a typed object which can be used for instantiation.
Ƭ FinallyHandler: function
Defined in src/types/finally-handler.ts:4
Handler for Do.try().finally(); Runs whether an error occurred or not.
▸ (): void
Ƭ OmitKeys: Omit‹TSource, keyof TExclusion›
Defined in src/types/omit-keys.ts:8
Omit all keys from TSource that intersect with TExclusion
Ƭ RequiredOr: object
Defined in src/types/required-or.ts:8
Mark all properties of T as required from the original type or another type
Ƭ RequiredOrUndefined: RequiredOr‹T, undefined›
Defined in src/types/required-or-undefined.ts:10
Mark all properties of T as required or explicitly set as undefined
Ƭ SyncWorkload: function
Defined in src/types/sync-workload.ts:4
Represents a synchronous method reference.
▸ (): T
Ƭ TimerFunctionReturn: object
Defined in src/types/timer-function-return.ts:1
- stop(
log?: undefined | false | true): number
• NetworkInformationUtils: object = buildNetworkInformationUtils( typeof window !== "undefined" ? window : undefined )
Defined in src/utilities/network-information-utils.ts:50
-
getNavigatorConnection(): NetworkInformation | undefined
-
getNetworkConnection(): NetworkConnection | undefined
• REGEX_VALID_CULTURE_CODE: RegExp‹› = /^([a-zA-Z]{2}((-|_)[a-zA-Z]{2})?)$/
Defined in src/utilities/string-utils.ts:21
Validates a culture code format. Based off of https://regexr.com/3faf5, but looser to allow dashes or underscores as separators.
example
en
en-US
en_US
en_us
EN_US
• REGEX_VALID_EMAIL: RegExp‹› = /^(([^<>()[]\.,;:\s@"]+(.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z-0-9]+.)+[a-zA-Z]{2,}))$/
Defined in src/utilities/string-utils.ts:22
• ResultErrorRecordFactory: IFactory‹ResultErrorRecord‹›› = Factory.define(
FactoryType.ResultErrorRecord,
ResultErrorRecord
)
.sequence("key", (i: number) => TEST_ERROR_KEY_${i})
.sequence("message", (i: number) => Test error message ${i})
Defined in src/tests/factories/result-error-record-factory.ts:9
• ResultRecordFactory: IFactory‹ResultRecord‹any›› = Factory.define<ResultRecord>( FactoryType.ResultRecord, ResultRecord )
Defined in src/tests/factories/result-record-factory.ts:9
• VideoResolutions: object[] = [ { height: 1080, label: "1080p(FHD)", ratio: "16:9", width: 1920, }, { height: 1200, label: "UXGA", ratio: "4:3", width: 1600, }, { height: 720, label: "720p(HD)", ratio: "16:9", width: 1280, }, { height: 600, label: "SVGA", ratio: "4:3", width: 800, }, { height: 480, label: "VGA", ratio: "4:3", width: 640, }, { height: 360, label: "360p(nHD)", ratio: "16:9", width: 640, }, { height: 288, label: "CIF", ratio: "4:3", width: 352, }, { height: 240, label: "QVGA", ratio: "4:3", width: 320, }, { height: 144, label: "QCIF", ratio: "4:3", width: 176, }, { height: 120, label: "QQVGA", ratio: "4:3", width: 160, }, ]
Defined in src/constants/video-resolutions.ts:1
• _currentCultureCode: string
Defined in src/utilities/service-utils.ts:16
• _defaultApiUrl: "/api/v1" = "/api/v1"
Defined in src/utilities/service-utils.ts:17
• _routeParamRegEx: RegExp‹› = /(:[a-z_-]*)/gi
Defined in src/utilities/route-utils.ts:8
• errorCultureIsRequired: "Culture is required" = "Culture is required"
Defined in src/utilities/localization-utils.ts:18
• routeParam: "culture" = "culture"
Defined in src/utilities/localization-utils.ts:23
Key name for handling language selection in routing (ie. queryString, path, etc...)
• t: translate = translate
Defined in src/utilities/localization-utils.ts:163
Retrieve translation for given key in the currently configured language
param culture resource key
param object key/values for interpolation of dynamic values
▸ intersectionWith<T1, T2>(array: List‹T1›, values: List‹T2›, comparator: Comparator2‹T1, T2›): T1[]
Defined in src/utilities/collection-utils.ts:187
Creates an array of unique array values not included in the other
provided arrays using SameValueZero
for equality comparisons.
example
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
_.intersectionWith(objects, others, _.isEqual); => [{ 'x': 1, 'y': 2 }]
Type parameters:
▪ T1
▪ T2
Parameters:
| Name | Type |
|---|---|
array |
List‹T1› |
values |
List‹T2› |
comparator |
Comparator2‹T1, T2› |
Returns: T1[]
Returns the new array of filtered values.
▸ _configure(cultureCode?: undefined | string, onApiResponseError?: undefined | function, onApiResponseSuccess?: undefined | function): void
Defined in src/utilities/service-utils.ts:31
Configures global service properties for your application
Parameters:
| Name | Type | Description |
|---|---|---|
cultureCode? |
undefined | string | Current culture code of the application |
onApiResponseError? |
undefined | function | Global handler called whenever there is an erroneous API response |
onApiResponseSuccess? |
undefined | function | Global handler called whenever there is a successful API response |
Returns: void
▸ _configureCultureCode(cultureCode?: undefined | string, apiUrl: string): void
Defined in src/utilities/service-utils.ts:46
Configure application's services for the provided culture
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
cultureCode? |
undefined | string | - | Requested RFC-4646 language code |
apiUrl |
string | _defaultApiUrl | Application's base api url (hopefully versioned) |
Returns: void
▸ _configureHeaders(): void
Defined in src/utilities/service-utils.ts:66
Configure axios HTTP headers
Returns: void
▸ _configureInterceptors(onApiResponseError?: undefined | function, onApiResponseSuccess?: undefined | function): void
Defined in src/utilities/service-utils.ts:78
Configures axios global API interceptors
Parameters:
| Name | Type | Description |
|---|---|---|
onApiResponseError? |
undefined | function | - |
onApiResponseSuccess? |
undefined | function |
Returns: void
▸ _isIE(): boolean
Defined in src/utilities/browser-utils.ts:14
Returns true if the detected browser is Internet Explorer.
Returns: boolean
boolean
▸ _isNotIE(): boolean
Defined in src/utilities/browser-utils.ts:22
Returns true if the brower is NOT Internet Explorer.
Returns: boolean
boolean
▸ _mapAxiosResponse<TRecord>(recordType: object, axiosResponse: AxiosResponse‹Result‹TRecord››): ServiceResponse‹TRecord›
Defined in src/utilities/service-utils.ts:93
Translates axios specific data response to a more generic ServiceResponse type for consumption throughout the system
Type parameters:
▪ TRecord
Parameters:
▪ recordType: object
| Name | Type |
|---|---|
constructor |
▪ axiosResponse: AxiosResponse‹Result‹TRecord››
Returns: ServiceResponse‹TRecord›
▸ _mapPagedAxiosResponse<TRecord>(recordType: object, axiosResponse: AxiosResponse‹PagedResult‹TRecord››): ServiceResponse‹TRecord›
Defined in src/utilities/service-utils.ts:121
Translates axios specific data responses to a more generic ServiceResponse type for consumption throughout the system
Type parameters:
▪ TRecord
Parameters:
▪ recordType: object
| Name | Type |
|---|---|
constructor |
▪ axiosResponse: AxiosResponse‹PagedResult‹TRecord››
Returns: ServiceResponse‹TRecord›
▸ _scrollToElementById(id: string, options: ScrollOptions): void
Defined in src/utilities/scroll-utils.ts:27
Attempts to scroll to the element specified by the given ID. In the event of a slow page render, the element may not be immediately available. This method will retry up to 50 times every 100ms to find the element before giving up.
Parameters:
| Name | Type | Default |
|---|---|---|
id |
string | - |
options |
ScrollOptions | DefaultScrollOptions |
Returns: void
▸ _scrollToHash(location: any, options: ScrollOptions): void
Defined in src/utilities/scroll-utils.ts:73
Attempts to scroll to the element specified in the hash of the current path. In the event of a slow page render, the element may not be immediately available. This method will retry up to 50 times every 100ms to find the element before giving up.
Reference: https://stackoverflow.com/a/54042987 https://stackoverflow.com/a/48195222
Parameters:
| Name | Type | Default |
|---|---|---|
location |
any | - |
options |
ScrollOptions | DefaultScrollOptions |
Returns: void
▸ appendQueryParams(path: string, queryParams: any, arrayFormat: QueryStringArrayFormat, arrayFormatSeparator: string | undefined): string
Defined in src/utilities/route-utils.ts:23
Appends the supplied query params object as a query string to path. Even if path is null.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
path |
string | - | Existing path (can be null) |
queryParams |
any | - | Object to transform into query string |
arrayFormat |
QueryStringArrayFormat | QueryStringArrayFormat.Index | Format to serialize arrays to a query string with. Defaults to "index". |
arrayFormatSeparator |
string | undefined | undefined | Seaparator character to use if using arrayFormat="separator" |
Returns: string
▸ buildNetworkInformationUtils(window?: Window): object
Defined in src/utilities/network-information-utils.ts:9
Parameters:
| Name | Type |
|---|---|
window? |
Window |
Returns: object
-
getNavigatorConnection(): NetworkInformation | undefined
-
getNetworkConnection(): NetworkConnection | undefined
▸ camelCase(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:36
Converts string to camel case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to convert. |
Returns: string
Returns the camel cased string.
▸ capitalize(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:44
Converts the first character of string to upper case and the remaining to lower case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to capitalize. |
Returns: string
Returns the capitalized string.
▸ changeCultureCode(cultureCode: string): Promise‹TFunction›
Defined in src/utilities/localization-utils.ts:50
Updates application's configured language used for translations
Parameters:
| Name | Type | Description |
|---|---|---|
cultureCode |
string | RFC-4646 culture code |
Returns: Promise‹TFunction›
▸ cultureCodeFromQueryString(): string
Defined in src/utilities/localization-utils.ts:56
Returns the culture code from the querystring, ie /login?culture=en-us
Returns: string
▸ cultureCodeFromRoute(): string
Defined in src/utilities/localization-utils.ts:64
Returns the culture code from the first position in the route, ie /en-us/xyz
Returns: string
▸ cultureFactory<TResources>(base: Culture‹any›, culture: Partial‹Culture‹TResources››): Culture‹TResources›
Defined in src/utilities/localization-utils.ts:71
Factory to build an inheritance chain for base to child Culture types
Type parameters:
▪ TResources
Parameters:
| Name | Type | Description |
|---|---|---|
base |
Culture‹any› | Base culture from core package |
culture |
Partial‹Culture‹TResources›› | subclass culture's partial properties to override 'base'. Typically where providing culture resources |
Returns: Culture‹TResources›
▸ culturesToResources<TResources>(cultures: Culture‹TResources›[]): any
Defined in src/utilities/localization-utils.ts:76
Type parameters:
▪ TResources
Parameters:
| Name | Type |
|---|---|
cultures |
Culture‹TResources›[] |
Returns: any
▸ currentCultureCode(): string
Defined in src/utilities/localization-utils.ts:89
Returns currently configured RFC-4646 culture code
Returns: string
▸ defaultCultureCode(): string
Defined in src/utilities/localization-utils.ts:91
Returns: string
▸ detectCultureCode(): string
Defined in src/utilities/localization-utils.ts:98
Detect and set current language for which to provide translations
Returns: string
string current RFC-4646 culture code
▸ difference<T>(array: List‹T› | null | undefined, ...values: Array‹List‹T››): T[]
Defined in src/utilities/collection-utils.ts:62
Creates an array of unique array values not included in the other provided arrays using SameValueZero for equality comparisons.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
array |
List‹T› | null | undefined | The array to inspect. |
...values |
Array‹List‹T›› | The arrays of values to exclude. |
Returns: T[]
Returns the new array of filtered values.
▸ equalsBy<T, V>(selector: function, array1: Array‹T› | List‹any› | undefined, array2: Array‹T› | List‹any› | undefined): boolean
Defined in src/utilities/collection-utils.ts:26
Compare two collections by a property of each value, specified by selector, not considering the order of elements, as long as all elements of one exist in the other.
Type parameters:
▪ T
▪ V
Parameters:
▪ selector: function
a function taking the item of the array and returning a property.
▸ (element: T): V
Parameters:
| Name | Type |
|---|---|
element |
T |
▪ array1: Array‹T› | List‹any› | undefined
first array to compare.
▪ array2: Array‹T› | List‹any› | undefined
second array to compare.
Returns: boolean
true if both arrays contain all the same elements of the other, not considering order, false otherwise.
▸ filename(value?: undefined | string): string | undefined
Defined in src/utilities/string-utils.ts:50
Returns the filename from the supplied string, including extension
Parameters:
| Name | Type | Description |
|---|---|---|
value? |
undefined | string |
Returns: string | undefined
▸ first<T>(array: List‹T› | null | undefined): T | undefined
Defined in src/utilities/collection-utils.ts:156
Gets the first element of array.
alias _.first
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
array |
List‹T› | null | undefined | The array to query. |
Returns: T | undefined
Returns the first element of array.
▸ flattenDeep<T>(array: ListOfRecursiveArraysOrValues‹T› | null | undefined): T[]
Defined in src/utilities/collection-utils.ts:73
Recursively flattens a nested array.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
array |
ListOfRecursiveArraysOrValues‹T› | null | undefined | The array to recursively flatten. |
Returns: T[]
Returns the new flattened array.
▸ getUrl(path: string, pathParams?: any): string
Defined in src/utilities/route-utils.ts:61
Convenience method to get a Url from a RouteDefinition
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | Route path template. Parameters in the path are denoted withed a colon :id |
pathParams? |
any | Object with keys matching supplied path template components |
Returns: string
▸ getUrlFromPath(path: string, pathParams?: any, queryParams?: any): string
Defined in src/utilities/route-utils.ts:71
Constructs a url from a formatted route path.
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | Route path template. Parameters in the path are denoted withed a colon :id |
pathParams? |
any | Object with keys matching supplied path template components |
queryParams? |
any | Object to get translated to the query string of the url |
Returns: string
▸ hasValue(value?: undefined | string): value is string
Defined in src/utilities/string-utils.ts:60
Determines whether or not the provided value is NOT undefined, null, or an empty string
(after trimming both ends of the string)
Parameters:
| Name | Type |
|---|---|
value? |
undefined | string |
Returns: value is string
▸ hasValues(collection: any[] | List‹any› | null | undefined): collection is any[] | List
Defined in src/utilities/collection-utils.ts:87
Checks for values in a collection. Returns false if the collection is undefined, null,
or the respective object type's "empty" state, ie length or size 0.
Note: only takes a single collection as parameter to make use of Typescript Type guard ability
Parameters:
| Name | Type |
|---|---|
collection |
any[] | List‹any› | null | undefined |
Returns: collection is any[] | List
False if collection is undefined, null, or has 0 elements.
True if collection contains any elements.
▸ initialize<TResources>(module: any, cultures: Culture‹TResources›[], options: LocalizationInitOptions): i18n
Defined in src/utilities/localization-utils.ts:125
Initialize frontend i18n module - typically in root/startup of application
Type parameters:
▪ TResources
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
module |
any | - | Third party module for use with i18next (ie. initReactI18next) |
cultures |
Culture‹TResources›[] | - | List of supported language cultures |
options |
LocalizationInitOptions | defaultInitOptions | Additional options for configuring i18n detection |
Returns: i18n
▸ intersection<T>(...arrays: Array‹List‹T››): T[]
Defined in src/utilities/collection-utils.ts:166
Creates an array of unique values that are included in all of the provided arrays using SameValueZero for equality comparisons.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
...arrays |
Array‹List‹T›› | The arrays to inspect. |
Returns: T[]
Returns the new array of shared values.
▸ isAbsoluteUrl(url: string): boolean
Defined in src/utilities/route-utils.ts:91
Determines if supplied url is an absolute url
Parameters:
| Name | Type | Description |
|---|---|---|
url |
string |
Returns: boolean
▸ isDevelopment(): boolean
Defined in src/utilities/environment-utils.ts:10
Function to return whether or not the current environment is development.
Returns: boolean
▸ isEmpty(collection: any[] | List‹any› | null | undefined): collection is undefined
Defined in src/utilities/collection-utils.ts:102
Checks if there aren't any values in a collection. Returns true if the collection is undefined,
null, or the respective object type's "empty" state, ie length or size 0.
Determines whether or not the provided value is undefined, null, or an empty string
(after trimming both ends of the string)
Note: only takes a single collection as parameter to make use of Typescript Type guard ability
Parameters:
| Name | Type | Description |
|---|---|---|
collection |
any[] | List‹any› | null | undefined |
Returns: collection is undefined
True if collection is undefined, null, or has 0 elements.
False if collection contains any elements.
▸ isEmpty(value?: undefined | string): value is undefined
Defined in src/utilities/string-utils.ts:71
Checks if there aren't any values in a collection. Returns true if the collection is undefined,
null, or the respective object type's "empty" state, ie length or size 0.
Determines whether or not the provided value is undefined, null, or an empty string
(after trimming both ends of the string)
Note: only takes a single collection as parameter to make use of Typescript Type guard ability
Parameters:
| Name | Type |
|---|---|
value? |
undefined | string |
Returns: value is undefined
True if collection is undefined, null, or has 0 elements.
False if collection contains any elements.
▸ isNotEmpty(collection: any[] | List‹any› | null | undefined): collection is any[] | List
Defined in src/utilities/collection-utils.ts:126
Checks for values in a collection. Returns false if the collection is undefined, null,
or the respective object type's "empty" state, ie length or size 0. Alias for CollectionUtils.hasValues
Note: only takes a single collection as parameter to make use of Typescript Type guard ability
Parameters:
| Name | Type |
|---|---|
collection |
any[] | List‹any› | null | undefined |
Returns: collection is any[] | List
False if collection is undefined, null, or has 0 elements.
True if collection contains any elements.
▸ isValidCultureCode(cultureCode?: undefined | string): cultureCode is string
Defined in src/utilities/string-utils.ts:80
Validates the given string as RFC-4646 culture code format
Parameters:
| Name | Type | Description |
|---|---|---|
cultureCode? |
undefined | string |
Returns: cultureCode is string
▸ isValidEmail(value?: undefined | string): value is string
Defined in src/utilities/string-utils.ts:88
Validates a given string matches a valid email format
Parameters:
| Name | Type | Description |
|---|---|---|
value? |
undefined | string |
Returns: value is string
▸ join(values: string[], separator: string): string
Defined in src/utilities/string-utils.ts:99
Joins an array of strings into one string with a separator. If the array is empty, it will return an empty string.
default ""
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
values |
string[] | - | Values to join into one string. |
separator |
string | "," | - |
Returns: string
▸ length(arr: Array‹any› | List‹any›): number
Defined in src/utilities/collection-utils.ts:136
Utility function to get the length of a collection when the collection might be either a Immutable.List or an Array
Parameters:
| Name | Type | Description |
|---|---|---|
arr |
Array‹any› | List‹any› | the collection |
Returns: number
number the length of the collection
▸ lowerFirst(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:113
Converts the first character of string to lower case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to convert. |
Returns: string
Returns the converted string.
▸ pad(string?: undefined | string, length?: undefined | number, chars?: undefined | string): string
Defined in src/utilities/string-utils.ts:124
Pads string on the left and right sides if it’s shorter than length. Padding characters are truncated if they can’t be evenly divided by length.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to pad. |
length? |
undefined | number | The padding length. |
chars? |
undefined | string | The string used as padding. |
Returns: string
Returns the padded string.
▸ padEnd(string?: undefined | string, length?: undefined | number, chars?: undefined | string): string
Defined in src/utilities/string-utils.ts:136
Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed length.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to pad. |
length? |
undefined | number | The padding length. |
chars? |
undefined | string | The string used as padding. |
Returns: string
Returns the padded string.
▸ padStart(string?: undefined | string, length?: undefined | number, chars?: undefined | string): string
Defined in src/utilities/string-utils.ts:148
Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed length.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to pad. |
length? |
undefined | number | The padding length. |
chars? |
undefined | string | The string used as padding. |
Returns: string
Returns the padded string.
▸ pluralize(number: number, singular?: undefined | string, plural?: undefined | string): string
Defined in src/utilities/string-utils.ts:166
Returns the plural version of a given word if the value is not 1. The default suffix is 's'.
example
Humanize.pluralize(1, "duck")
=> "duck"
Humanize.pluralize(3, "duck") => "ducks"
Humanize.pluralize(3, "duck", "duckies") => "duckies"
Parameters:
| Name | Type |
|---|---|
number |
number |
singular? |
undefined | string |
plural? |
undefined | string |
Returns: string
▸ queryStringToObject<T>(queryString: string, arrayFormat: QueryStringArrayFormat, parseNumbers: boolean, parseBooleans: boolean): T
Defined in src/utilities/route-utils.ts:101
Parse a query string and return an object of type T
Type parameters:
▪ T
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
queryString |
string | - | current query string |
arrayFormat |
QueryStringArrayFormat | QueryStringArrayFormat.Index | format to parse arrays from |
parseNumbers |
boolean | true | convert numbers to number type from string |
parseBooleans |
boolean | true | convert booleans to boolean type from string |
Returns: T
▸ registerPromiseFinallyPolyfill(): void
Defined in src/utilities/polyfill-utils.ts:9
Promise.finally is not natively supported in Internet Explorer.
Returns: void
▸ removeElementAt<T>(source: Array‹T›, index: number): Array‹T›
Defined in src/utilities/collection-utils.ts:198
Removes a supplied element by index
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
source |
Array‹T› | original array |
index |
number | array index to remove |
Returns: Array‹T›
▸ repeat(string?: undefined | string, n?: undefined | number): string
Defined in src/utilities/string-utils.ts:179
Repeats the given string n times.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to repeat. |
n? |
undefined | number | The number of times to repeat the string. |
Returns: string
Returns the repeated string.
▸ replaceElementAt<T>(source: Array‹T›, index: number, value: T): Array‹T›
Defined in src/utilities/collection-utils.ts:218
Returns a NEW array with the element at the specified index replaced with the specified value if the index provided is greater than zero, else it returns the source array. Since it returns a new array, this can be safely used as the value for a React.SetStateAction i.e. setMyArray(CollectionUtils.replaceElementAt(myArray, index, newValue));
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
source |
Array‹T› | - |
index |
number | - |
value |
T |
Returns: Array‹T›
▸ replacePathParams(path: string, pathParams: any): string
Defined in src/utilities/route-utils.ts:120
Replace routing components in supplied path with keys and values of supplied pathParams.
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | Path containing routing components (format: ':key'). Throws an error if any components aren't found in the pathParams object. |
pathParams |
any | Object to transform into the supplied path. |
Returns: string
▸ runIfDevelopment(fn: function): void
Defined in src/utilities/environment-utils.ts:19
Conditionally runs the given function, depending on whether the current environment is development or not.
Parameters:
▪ fn: function
Function to be run in a development environment only.
▸ (): any
Returns: void
▸ sample<T>(collection: List‹T› | Dictionary‹T› | NumericDictionary‹T› | null | undefined): T | undefined
Defined in src/utilities/collection-utils.ts:243
Gets a random element from collection.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
collection |
List‹T› | Dictionary‹T› | NumericDictionary‹T› | null | undefined | The collection to sample. |
Returns: T | undefined
Returns the random element.
▸ sampleSize<T>(collection: List‹T› | Dictionary‹T› | NumericDictionary‹T› | null | undefined, n?: undefined | number): T[]
Defined in src/utilities/collection-utils.ts:259
Gets n random elements at unique keys from collection up to the size of collection.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
collection |
List‹T› | Dictionary‹T› | NumericDictionary‹T› | null | undefined | The collection to sample. |
n? |
undefined | number | The number of elements to sample. |
Returns: T[]
Returns the random elements.
▸ snakeCase(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:187
Converts string to snake case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to convert. |
Returns: string
Returns the snake cased string.
▸ sortByString<T>(array: Array‹T›, selector: function, caseSensitive: boolean): T[]
Defined in src/utilities/collection-utils.ts:275
Sort an array of items alphabetically by one property of the item.
Type parameters:
▪ T: any
Parameters:
▪ array: Array‹T›
the source array of items
▪ selector: function
function returning property to sort by from item
▸ (element: T): string
Parameters:
| Name | Type |
|---|---|
element |
T |
▪Default value caseSensitive: boolean= false
whether to consider letter case when sorting
Returns: T[]
▸ startCase(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:195
Converts string to start case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to convert. |
Returns: string
Returns the start cased string.
▸ take<T>(array: List‹T› | null | undefined, n?: undefined | number): T[]
Defined in src/utilities/collection-utils.ts:315
Creates a slice of array with n elements taken from the beginning.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
array |
List‹T› | null | undefined | The array to query. |
n? |
undefined | number | The number of elements to take. |
Returns: T[]
Returns the slice of array.
▸ template(string?: undefined | string, options?: TemplateOptions): TemplateExecutor
Defined in src/utilities/string-utils.ts:223
Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is provided it takes precedence over _.templateSettings values.
Note: In the development build _.template utilizes sourceURLs for easier debugging.
For more information on precompiling templates see lodash's custom builds documentation.
For more information on Chrome extension sandboxes see Chrome's extensions documentation.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The template string. |
options? |
TemplateOptions | The options object. |
Returns: TemplateExecutor
Returns the compiled template function.
▸ translate(key: string, options?: any): string
Defined in src/utilities/localization-utils.ts:156
Retrieve translation for given key in the currently configured language
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | culture resource key |
options? |
any | object key/values for interpolation of dynamic values |
Returns: string
▸ truncateRight(value: string, truncateAtPos: number): string
Defined in src/utilities/string-utils.ts:228
Parameters:
| Name | Type |
|---|---|
value |
string |
truncateAtPos |
number |
Returns: string
▸ upperFirst(string?: undefined | string): string
Defined in src/utilities/string-utils.ts:246
Converts the first character of string to upper case.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to convert. |
Returns: string
Returns the converted string.
▸ words(string?: undefined | string, pattern?: string | RegExp): string[]
Defined in src/utilities/string-utils.ts:255
Splits string into an array of its words.
Parameters:
| Name | Type | Description |
|---|---|---|
string? |
undefined | string | The string to inspect. |
pattern? |
string | RegExp | The pattern to match words. |
Returns: string[]
Returns the words of string.
Defined in src/constants/auditable-default-values.ts:7
• createdById: undefined = undefined
Defined in src/constants/auditable-default-values.ts:8
• createdOn: undefined = undefined
Defined in src/constants/auditable-default-values.ts:9
• deletedById: undefined = undefined
Defined in src/constants/auditable-default-values.ts:10
• deletedOn: undefined = undefined
Defined in src/constants/auditable-default-values.ts:11
• id: undefined = undefined
Defined in src/constants/auditable-default-values.ts:12
• updatedById: undefined = undefined
Defined in src/constants/auditable-default-values.ts:13
• updatedOn: undefined = undefined
Defined in src/constants/auditable-default-values.ts:14
Defined in src/cultures/base-english-united-states.ts:4
• code: string = Rfc4646LanguageCodes.EN_US
Defined in src/cultures/base-english-united-states.ts:5
• resources: null = null
Defined in src/cultures/base-english-united-states.ts:6
Defined in src/cultures/base-spanish-spain.ts:4
• code: string = Rfc4646LanguageCodes.ES_ES
Defined in src/cultures/base-spanish-spain.ts:5
• resources: null = null
Defined in src/cultures/base-spanish-spain.ts:6
Defined in src/utilities/browser-utils.ts:24
• isIE: _isIE = _isIE
Defined in src/utilities/browser-utils.ts:25
• isNotIE: _isNotIE = _isNotIE
Defined in src/utilities/browser-utils.ts:26
Defined in src/utilities/collection-utils.ts:324
• difference: difference
Defined in src/utilities/collection-utils.ts:325
• equalsBy: equalsBy
Defined in src/utilities/collection-utils.ts:326
• first: first
Defined in src/utilities/collection-utils.ts:327
• flattenDeep: flattenDeep
Defined in src/utilities/collection-utils.ts:328
• hasValues: hasValues
Defined in src/utilities/collection-utils.ts:329
• intersection: intersection
Defined in src/utilities/collection-utils.ts:332
• intersectionWith: intersectionWith
Defined in src/utilities/collection-utils.ts:333
• isEmpty: isEmpty
Defined in src/utilities/collection-utils.ts:330
• isNotEmpty: isNotEmpty
Defined in src/utilities/collection-utils.ts:331
• length: length
Defined in src/utilities/collection-utils.ts:334
• removeElementAt: removeElementAt
Defined in src/utilities/collection-utils.ts:335
• replaceElementAt: replaceElementAt
Defined in src/utilities/collection-utils.ts:336
• sample: sample
Defined in src/utilities/collection-utils.ts:337
• sampleSize: sampleSize
Defined in src/utilities/collection-utils.ts:338
• sortByString: sortByString
Defined in src/utilities/collection-utils.ts:339
• take: take
Defined in src/utilities/collection-utils.ts:340
Defined in src/utilities/core-utils.ts:15
▸ bindAll<T>(object: T, ...methodNames: Array‹string | string[]›): T
Defined in src/utilities/core-utils.ts:28
Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all enumerable function properties, own and inherited, of object are bound.
Note: This method does not set the "length" property of bound functions.
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
object |
T | The object to bind and assign the bound methods to. |
...methodNames |
Array‹string | string[]› | The object method names to bind, specified as individual method names or arrays of method names. |
Returns: T
Returns object.
▸ curry<T1, R>(func: function, arity?: undefined | number): CurriedFunction1‹T1, R›
Defined in src/utilities/core-utils.ts:40
Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
Type parameters:
▪ T1
▪ R
Parameters:
▪ func: function
The function to curry.
▸ (t1: T1): R
Parameters:
| Name | Type |
|---|---|
t1 |
T1 |
▪Optional arity: undefined | number
The arity of func.
Returns: CurriedFunction1‹T1, R›
Returns the new curried function.
▸ enumToArray<TEnum>(enumObject: any): TEnum[]
Defined in src/utilities/core-utils.ts:55
Transforms an enum into an array of its values
example
const roleTypes = TestUtils.enumToArray(RoleType);
// Returns [0, 1, 2, 3, 4, 5]
Type parameters:
▪ TEnum
The enum to be transformed
Parameters:
| Name | Type | Description |
|---|---|---|
enumObject |
any | The enum to be transformed (cannot be typed to TEnum, or TS will return 'typeof TEnum' instead of a value of TEnum) |
Returns: TEnum[]
▸ getRandomEnum<TEnum>(enumObject: any, excludeElement?: TEnum): TEnum
Defined in src/utilities/core-utils.ts:73
Returns a random enum value from its type
example
const randomRoleType = TestUtils.getRandomEnum(RoleType);
// Might return the value '1', which is the value of RoleType.Team
Type parameters:
▪ TEnum
The enum to be transformed
Parameters:
| Name | Type | Description |
|---|---|---|
enumObject |
any | The enum to be transformed (cannot be typed to TEnum, or TS will return 'typeof TEnum' instead of a value of TEnum) |
excludeElement? |
TEnum | - |
Returns: TEnum
▸ memoize<T>(func: T, resolver?: undefined | function): T & MemoizedFunction
Defined in src/utilities/core-utils.ts:93
Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.
Type parameters:
▪ T: function
Parameters:
| Name | Type | Description |
|---|---|---|
func |
T | The function to have its output memoized. |
resolver? |
undefined | function | The function to resolve the cache key. |
Returns: T & MemoizedFunction
Returns the new memoizing function.
▸ merge<TObject, TSource>(object: TObject, source: TSource): TObject & TSource
Defined in src/utilities/core-utils.ts:108
Recursively merges own and inherited enumerable properties of source
objects into the destination object, skipping source properties that resolve
to undefined. Array and plain object properties are merged recursively.
Other objects and value types are overridden by assignment. Source objects
are applied from left to right. Subsequent sources overwrite property
assignments of previous sources.
Type parameters:
▪ TObject
▪ TSource
Parameters:
| Name | Type |
|---|---|
object |
TObject |
source |
TSource |
Returns: TObject & TSource
▸ numericEnumToPojo(enumObject: any): any
Defined in src/utilities/core-utils.ts:121
Returns a plain javascript object based on the given enum
Parameters:
| Name | Type |
|---|---|
enumObject |
any |
Returns: any
▸ objectToArray(object: any): any[]
Defined in src/utilities/core-utils.ts:139
Returns an array of an object's values
Parameters:
| Name | Type |
|---|---|
object |
any |
Returns: any[]
▸ range(start: number, end?: undefined | number, step?: undefined | number): number[]
Defined in src/utilities/core-utils.ts:165
Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length range is created unless a negative step is specified.
Parameters:
| Name | Type | Description |
|---|---|---|
start |
number | The start of the range. |
end? |
undefined | number | The end of the range. |
step? |
undefined | number | The value to increment or decrement by. |
Returns: number[]
Returns a new range array.
▸ sleep(milliseconds: number, debug: boolean): Promise‹void›
Defined in src/utilities/core-utils.ts:174
Wrap timeout in a promise so tests can easily block execution for testing time
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
milliseconds |
number | - | - |
debug |
boolean | false |
Returns: Promise‹void›
▸ sleepSync(milliseconds: number): void
Defined in src/utilities/core-utils.ts:194
Block execution for specified number of milliseconds, synchronously.
Parameters:
| Name | Type | Description |
|---|---|---|
milliseconds |
number | the delay |
Returns: void
▸ throttle<T>(func: T, wait?: undefined | number, options?: ThrottleSettings): T & Cancelable
Defined in src/utilities/core-utils.ts:218
Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function return the result of the last func call.
Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout.
Type parameters:
▪ T: function
Parameters:
| Name | Type | Description |
|---|---|---|
func |
T | The function to throttle. |
wait? |
undefined | number | The number of milliseconds to throttle invocations to. |
options? |
ThrottleSettings | The options object. |
Returns: T & Cancelable
Returns the new throttled function.
▸ timer(name: string): TimerFunctionReturn
Defined in src/utilities/core-utils.ts:231
Creates a timer instance that when stopped will supply elapsed time in milliseconds. Useful for benchmarking or providing counters
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Useful name to identify the timer |
Returns: TimerFunctionReturn
▸ times<TResult>(n: number, iteratee: function): TResult[]
Defined in src/utilities/core-utils.ts:259
Invokes the iteratee function n times, returning an array of the results of each invocation. The iteratee is invoked with one argument; (index).
Type parameters:
▪ TResult
Parameters:
▪ n: number
The number of times to invoke iteratee.
▪ iteratee: function
The function invoked per iteration.
▸ (num: number): TResult
Parameters:
| Name | Type |
|---|---|
num |
number |
Returns: TResult[]
Returns the array of results.
Defined in src/utilities/scroll-utils.ts:9
• behavior: "auto" = "auto"
Defined in src/utilities/scroll-utils.ts:10
• block: "start" = "start"
Defined in src/utilities/scroll-utils.ts:11
• inline: "nearest" = "nearest"
Defined in src/utilities/scroll-utils.ts:12
Defined in src/constants/email-constants.ts:4
These values are from the RFC-5231 Email specification
• addressMaxLength: number = 250
Defined in src/constants/email-constants.ts:5
• subjectMaxLength: number = 78
Defined in src/constants/email-constants.ts:6
Defined in src/utilities/environment-utils.ts:33
• isDevelopment: isDevelopment
Defined in src/utilities/environment-utils.ts:34
• runIfDevelopment: runIfDevelopment
Defined in src/utilities/environment-utils.ts:35
Defined in src/tests/factories/factory-type.ts:1
• ResultErrorRecord: string = "ResultErrorRecord"
Defined in src/tests/factories/factory-type.ts:2
• ResultRecord: string = "ResultRecord"
Defined in src/tests/factories/factory-type.ts:3
• StubResourceRecord: string = "StubResourceRecord"
Defined in src/tests/factories/factory-type.ts:4
Defined in src/utilities/localization-utils.ts:171
• changeCultureCode: changeCultureCode
Defined in src/utilities/localization-utils.ts:172
• cultureCodeFromQueryString: cultureCodeFromQueryString
Defined in src/utilities/localization-utils.ts:173
• cultureCodeFromRoute: cultureCodeFromRoute
Defined in src/utilities/localization-utils.ts:174
• cultureFactory: cultureFactory
Defined in src/utilities/localization-utils.ts:175
• currentCultureCode: currentCultureCode
Defined in src/utilities/localization-utils.ts:176
• defaultCultureCode: defaultCultureCode
Defined in src/utilities/localization-utils.ts:177
• defaultInitOptions: LocalizationInitOptions‹›
Defined in src/utilities/localization-utils.ts:178
• detectCultureCode: detectCultureCode
Defined in src/utilities/localization-utils.ts:179
• errorCultureIsRequired: string
Defined in src/utilities/localization-utils.ts:180
• initialize: initialize
Defined in src/utilities/localization-utils.ts:181
• routeParam: string
Defined in src/utilities/localization-utils.ts:182
• t: translate
Defined in src/utilities/localization-utils.ts:183
• translate: translate
Defined in src/utilities/localization-utils.ts:184
Defined in src/utilities/polyfill-utils.ts:31
• registerPromiseFinallyPolyfill: registerPromiseFinallyPolyfill
Defined in src/utilities/polyfill-utils.ts:32
Defined in src/utilities/promise-factory.ts:7
▸ cancellable<T>(promise: Promise‹T›): CancellablePromise‹T›
Defined in src/utilities/promise-factory.ts:8
Type parameters:
▪ T
Parameters:
| Name | Type |
|---|---|
promise |
Promise‹T› |
Returns: CancellablePromise‹T›
▸ pending(): Promise‹unknown›
Defined in src/utilities/promise-factory.ts:32
Creates a new and empty/unfullfilled promise to cancel further chained promise operations
Returns: Promise‹unknown›
Defined in src/utilities/record-utils.ts:12
▸ auditableDefaultValuesFactory<T>(defaultValues: RequiredOrUndefined‹OmitKeys‹T, Auditable››): T
Defined in src/utilities/record-utils.ts:18
Returns object of type T with Auditable values (createdById, createdOn, etc.) set to undefined
Type parameters:
▪ T: Auditable
Parameters:
| Name | Type | Description |
|---|---|---|
defaultValues |
RequiredOrUndefined‹OmitKeys‹T, Auditable›› | Object with all non-Auditable properties set to a default value (or undefined) |
Returns: T
▸ defaultValuesFactory<T>(defaultValues: RequiredOrUndefined‹T›): T
Defined in src/utilities/record-utils.ts:30
Returns object cast back as type T to ensure all properties are set for use with a Record
class definition
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
defaultValues |
RequiredOrUndefined‹T› | Object with all properties set to a default value (or undefined) |
Returns: T
▸ ensureRecord<TValue, TRecord>(maybeRecord: TValue, record: Constructor‹TRecord›): TRecord
Defined in src/utilities/record-utils.ts:43
Function to ensure a given object is an instance of a specific Record T. If it is not, one will
be instantiated with the given constructor.
If maybeRecord is already an instance of T, it returns that value.
Type parameters:
▪ TValue
▪ TRecord: TValue
Parameters:
| Name | Type | Description |
|---|---|---|
maybeRecord |
TValue | Object or Record to be coalesced into a Record. |
record |
Constructor‹TRecord› | Type of the Record to be instantiated |
Returns: TRecord
▸ ensureRecords<TValue, TRecord>(maybeRecords: TValue[], record: Constructor‹TRecord›): TRecord[]
Defined in src/utilities/record-utils.ts:61
Function to ensure a given array of objects are instances of a specific Record T. If they
are not, one will be instantiated with the given constructor.
If maybeRecord is already an instance of T, it returns that value.
Type parameters:
▪ TValue
▪ TRecord: TValue
Parameters:
| Name | Type | Description |
|---|---|---|
maybeRecords |
TValue[] | Array of objects or Records to be coalesced into Records. |
record |
Constructor‹TRecord› | Type of the Record to be instantiated |
Returns: TRecord[]
▸ isRecord<TValue, TRecord>(maybeRecord: TValue, record: Constructor‹TRecord›): maybeRecord is TRecord
Defined in src/utilities/record-utils.ts:76
Function to verify a given object is an instance of a specific Record T.
Type parameters:
▪ TValue
▪ TRecord: TValue
Parameters:
| Name | Type | Description |
|---|---|---|
maybeRecord |
TValue | Object or Record to be checked as an instance of T |
record |
Constructor‹TRecord› | Type of the Record to be checked |
Returns: maybeRecord is TRecord
Defined in src/constants/rfc4646-language-codes.ts:1
• AF_ZA: string = "af-ZA"
Defined in src/constants/rfc4646-language-codes.ts:2
• AR_AE: string = "ar-AE"
Defined in src/constants/rfc4646-language-codes.ts:18
• AR_BH: string = "ar-BH"
Defined in src/constants/rfc4646-language-codes.ts:5
• AR_DZ: string = "ar-DZ"
Defined in src/constants/rfc4646-language-codes.ts:4
• AR_EG: string = "ar-EG"
Defined in src/constants/rfc4646-language-codes.ts:6
• AR_IQ: string = "ar-IQ"
Defined in src/constants/rfc4646-language-codes.ts:7
• AR_JO: string = "ar-JO"
Defined in src/constants/rfc4646-language-codes.ts:8
• AR_KW: string = "ar-KW"
Defined in src/constants/rfc4646-language-codes.ts:9
• AR_LB: string = "ar-LB"
Defined in src/constants/rfc4646-language-codes.ts:10
• AR_LY: string = "ar-LY"
Defined in src/constants/rfc4646-language-codes.ts:11
• AR_MA: string = "ar-MA"
Defined in src/constants/rfc4646-language-codes.ts:12
• AR_OM: string = "ar-OM"
Defined in src/constants/rfc4646-language-codes.ts:13
• AR_QA: string = "ar-QA"
Defined in src/constants/rfc4646-language-codes.ts:14
• AR_SA: string = "ar-SA"
Defined in src/constants/rfc4646-language-codes.ts:15
• AR_SY: string = "ar-SY"
Defined in src/constants/rfc4646-language-codes.ts:16
• AR_TN: string = "ar-TN"
Defined in src/constants/rfc4646-language-codes.ts:17
• AR_YE: string = "ar-YE"
Defined in src/constants/rfc4646-language-codes.ts:19
• BE_BY: string = "be-BY"
Defined in src/constants/rfc4646-language-codes.ts:24
• BG_BG: string = "bg-BG"
Defined in src/constants/rfc4646-language-codes.ts:25
• CA_ES: string = "ca-ES"
Defined in src/constants/rfc4646-language-codes.ts:26
• CS_CZ: string = "cs-CZ"
Defined in src/constants/rfc4646-language-codes.ts:35
• CY_AZ_AZ: string = "Cy-az-AZ"
Defined in src/constants/rfc4646-language-codes.ts:21
• CY_SR_SP: string = "Cy-sr-SP"
Defined in src/constants/rfc4646-language-codes.ts:101
• CY_UZ_UZ: string = "Cy-uz-UZ"
Defined in src/constants/rfc4646-language-codes.ts:135
• DA_DK: string = "da-DK"
Defined in src/constants/rfc4646-language-codes.ts:36
• DE_AT: string = "de-AT"
Defined in src/constants/rfc4646-language-codes.ts:65
• DE_CH: string = "de-CH"
Defined in src/constants/rfc4646-language-codes.ts:69
• DE_DE: string = "de-DE"
Defined in src/constants/rfc4646-language-codes.ts:66
• DE_LI: string = "de-LI"
Defined in src/constants/rfc4646-language-codes.ts:67
• DE_LU: string = "de-LU"
Defined in src/constants/rfc4646-language-codes.ts:68
• DIV_MV: string = "div-MV"
Defined in src/constants/rfc4646-language-codes.ts:37
• EL_GR: string = "el-GR"
Defined in src/constants/rfc4646-language-codes.ts:70
• EN_AU: string = "en-AU"
Defined in src/constants/rfc4646-language-codes.ts:40
• EN_BZ: string = "en-BZ"
Defined in src/constants/rfc4646-language-codes.ts:41
• EN_CA: string = "en-CA"
Defined in src/constants/rfc4646-language-codes.ts:42
• EN_CB: string = "en-CB"
Defined in src/constants/rfc4646-language-codes.ts:43
• EN_GB: string = "en-GB"
Defined in src/constants/rfc4646-language-codes.ts:50
• EN_IE: string = "en-IE"
Defined in src/constants/rfc4646-language-codes.ts:44
• EN_JM: string = "en-JM"
Defined in src/constants/rfc4646-language-codes.ts:45
• EN_NZ: string = "en-NZ"
Defined in src/constants/rfc4646-language-codes.ts:46
• EN_PH: string = "en-PH"
Defined in src/constants/rfc4646-language-codes.ts:47
• EN_TT: string = "en-TT"
Defined in src/constants/rfc4646-language-codes.ts:49
• EN_US: string = "en-US"
Defined in src/constants/rfc4646-language-codes.ts:51
• EN_ZA: string = "en-ZA"
Defined in src/constants/rfc4646-language-codes.ts:48
• EN_ZW: string = "en-ZW"
Defined in src/constants/rfc4646-language-codes.ts:52
• ES_AR: string = "es-AR"
Defined in src/constants/rfc4646-language-codes.ts:105
• ES_BO: string = "es-BO"
Defined in src/constants/rfc4646-language-codes.ts:106
• ES_CL: string = "es-CL"
Defined in src/constants/rfc4646-language-codes.ts:107
• ES_CO: string = "es-CO"
Defined in src/constants/rfc4646-language-codes.ts:108
• ES_CR: string = "es-CR"
Defined in src/constants/rfc4646-language-codes.ts:109
• ES_DO: string = "es-DO"
Defined in src/constants/rfc4646-language-codes.ts:110
• ES_EC: string = "es-EC"
Defined in src/constants/rfc4646-language-codes.ts:111
• ES_ES: string = "es-ES"
Defined in src/constants/rfc4646-language-codes.ts:121
• ES_GT: string = "es-GT"
Defined in src/constants/rfc4646-language-codes.ts:113
• ES_HN: string = "es-HN"
Defined in src/constants/rfc4646-language-codes.ts:114
• ES_MX: string = "es-MX"
Defined in src/constants/rfc4646-language-codes.ts:115
• ES_NI: string = "es-NI"
Defined in src/constants/rfc4646-language-codes.ts:116
• ES_PA: string = "es-PA"
Defined in src/constants/rfc4646-language-codes.ts:117
• ES_PE: string = "es-PE"
Defined in src/constants/rfc4646-language-codes.ts:119
• ES_PR: string = "es-PR"
Defined in src/constants/rfc4646-language-codes.ts:120
• ES_PY: string = "es-PY"
Defined in src/constants/rfc4646-language-codes.ts:118
• ES_SV: string = "es-SV"
Defined in src/constants/rfc4646-language-codes.ts:112
• ES_UY: string = "es-UY"
Defined in src/constants/rfc4646-language-codes.ts:122
• ES_VE: string = "es-VE"
Defined in src/constants/rfc4646-language-codes.ts:123
• ET_EE: string = "et-EE"
Defined in src/constants/rfc4646-language-codes.ts:53
• EU_ES: string = "eu-ES"
Defined in src/constants/rfc4646-language-codes.ts:23
• FA_IR: string = "fa-IR"
Defined in src/constants/rfc4646-language-codes.ts:55
• FI_FI: string = "fi-FI"
Defined in src/constants/rfc4646-language-codes.ts:56
• FO_FO: string = "fo-FO"
Defined in src/constants/rfc4646-language-codes.ts:54
• FR_BE: string = "fr-BE"
Defined in src/constants/rfc4646-language-codes.ts:57
• FR_CA: string = "fr-CA"
Defined in src/constants/rfc4646-language-codes.ts:58
• FR_CH: string = "fr-CH"
Defined in src/constants/rfc4646-language-codes.ts:62
• FR_FR: string = "fr-FR"
Defined in src/constants/rfc4646-language-codes.ts:59
• FR_LU: string = "fr-LU"
Defined in src/constants/rfc4646-language-codes.ts:60
• FR_MC: string = "fr-MC"
Defined in src/constants/rfc4646-language-codes.ts:61
• GL_ES: string = "gl-ES"
Defined in src/constants/rfc4646-language-codes.ts:63
• GU_IN: string = "gu-IN"
Defined in src/constants/rfc4646-language-codes.ts:71
• HE_IL: string = "he-IL"
Defined in src/constants/rfc4646-language-codes.ts:72
• HI_IN: string = "hi-IN"
Defined in src/constants/rfc4646-language-codes.ts:73
• HR_HR: string = "hr-HR"
Defined in src/constants/rfc4646-language-codes.ts:34
• HU_HU: string = "hu-HU"
Defined in src/constants/rfc4646-language-codes.ts:74
• HY_AM: string = "hy-AM"
Defined in src/constants/rfc4646-language-codes.ts:20
• ID_ID: string = "id-ID"
Defined in src/constants/rfc4646-language-codes.ts:76
• IS_IS: string = "is-IS"
Defined in src/constants/rfc4646-language-codes.ts:75
• IT_CH: string = "it-CH"
Defined in src/constants/rfc4646-language-codes.ts:78
• IT_IT: string = "it-IT"
Defined in src/constants/rfc4646-language-codes.ts:77
• JA_JP: string = "ja-JP"
Defined in src/constants/rfc4646-language-codes.ts:79
• KA_GE: string = "ka-GE"
Defined in src/constants/rfc4646-language-codes.ts:64
• KK_KZ: string = "kk-KZ"
Defined in src/constants/rfc4646-language-codes.ts:81
• KN_IN: string = "kn-IN"
Defined in src/constants/rfc4646-language-codes.ts:80
• KOK_IN: string = "kok-IN"
Defined in src/constants/rfc4646-language-codes.ts:82
• KO_KR: string = "ko-KR"
Defined in src/constants/rfc4646-language-codes.ts:83
• KY_KZ: string = "ky-KZ"
Defined in src/constants/rfc4646-language-codes.ts:84
• LT_AZ_AZ: string = "Lt-az-AZ"
Defined in src/constants/rfc4646-language-codes.ts:22
• LT_LT: string = "lt-LT"
Defined in src/constants/rfc4646-language-codes.ts:86
• LT_SR_SP: string = "Lt-sr-SP"
Defined in src/constants/rfc4646-language-codes.ts:102
• LT_UZ_UZ: string = "Lt-uz-UZ"
Defined in src/constants/rfc4646-language-codes.ts:136
• LV_LV: string = "lv-LV"
Defined in src/constants/rfc4646-language-codes.ts:85
• MK_MK: string = "mk-MK"
Defined in src/constants/rfc4646-language-codes.ts:87
• MN_MN: string = "mn-MN"
Defined in src/constants/rfc4646-language-codes.ts:91
• MR_IN: string = "mr-IN"
Defined in src/constants/rfc4646-language-codes.ts:90
• MS_BN: string = "ms-BN"
Defined in src/constants/rfc4646-language-codes.ts:88
• MS_MY: string = "ms-MY"
Defined in src/constants/rfc4646-language-codes.ts:89
• NB_NO: string = "nb-NO"
Defined in src/constants/rfc4646-language-codes.ts:92
• NL_BE: string = "nl-BE"
Defined in src/constants/rfc4646-language-codes.ts:38
• NL_NL: string = "nl-NL"
Defined in src/constants/rfc4646-language-codes.ts:39
• NN_NO: string = "nn-NO"
Defined in src/constants/rfc4646-language-codes.ts:93
• PA_IN: string = "pa-IN"
Defined in src/constants/rfc4646-language-codes.ts:97
• PL_PL: string = "pl-PL"
Defined in src/constants/rfc4646-language-codes.ts:94
• PT_BR: string = "pt-BR"
Defined in src/constants/rfc4646-language-codes.ts:95
• PT_PT: string = "pt-PT"
Defined in src/constants/rfc4646-language-codes.ts:96
• RO_RO: string = "ro-RO"
Defined in src/constants/rfc4646-language-codes.ts:98
• RU_RU: string = "ru-RU"
Defined in src/constants/rfc4646-language-codes.ts:99
• SA_IN: string = "sa-IN"
Defined in src/constants/rfc4646-language-codes.ts:100
• SK_SK: string = "sk-SK"
Defined in src/constants/rfc4646-language-codes.ts:103
• SL_SI: string = "sl-SI"
Defined in src/constants/rfc4646-language-codes.ts:104
• SQ_AL: string = "sq-AL"
Defined in src/constants/rfc4646-language-codes.ts:3
• SV_FI: string = "sv-FI"
Defined in src/constants/rfc4646-language-codes.ts:125
• SV_SE: string = "sv-SE"
Defined in src/constants/rfc4646-language-codes.ts:126
• SW_KE: string = "sw-KE"
Defined in src/constants/rfc4646-language-codes.ts:124
• SYR_SY: string = "syr-SY"
Defined in src/constants/rfc4646-language-codes.ts:127
• TA_IN: string = "ta-IN"
Defined in src/constants/rfc4646-language-codes.ts:128
• TE_IN: string = "te-IN"
Defined in src/constants/rfc4646-language-codes.ts:130
• TH_TH: string = "th-TH"
Defined in src/constants/rfc4646-language-codes.ts:131
• TR_TR: string = "tr-TR"
Defined in src/constants/rfc4646-language-codes.ts:132
• TT_RU: string = "tt-RU"
Defined in src/constants/rfc4646-language-codes.ts:129
• UK_UA: string = "uk-UA"
Defined in src/constants/rfc4646-language-codes.ts:133
• UR_PK: string = "ur-PK"
Defined in src/constants/rfc4646-language-codes.ts:134
• VI_VN: string = "vi-VN"
Defined in src/constants/rfc4646-language-codes.ts:137
• ZH_CHS: string = "zh-CHS"
Defined in src/constants/rfc4646-language-codes.ts:32
• ZH_CHT: string = "zh-CHT"
Defined in src/constants/rfc4646-language-codes.ts:33
• ZH_CN: string = "zh-CN"
Defined in src/constants/rfc4646-language-codes.ts:27
• ZH_HK: string = "zh-HK"
Defined in src/constants/rfc4646-language-codes.ts:28
• ZH_MO: string = "zh-MO"
Defined in src/constants/rfc4646-language-codes.ts:29
• ZH_SG: string = "zh-SG"
Defined in src/constants/rfc4646-language-codes.ts:30
• ZH_TW: string = "zh-TW"
Defined in src/constants/rfc4646-language-codes.ts:31
Defined in src/utilities/route-utils.ts:146
• appendQueryParams: appendQueryParams
Defined in src/utilities/route-utils.ts:147
• getUrl: getUrl
Defined in src/utilities/route-utils.ts:148
• getUrlFromPath: getUrlFromPath
Defined in src/utilities/route-utils.ts:149
• isAbsoluteUrl: isAbsoluteUrl
Defined in src/utilities/route-utils.ts:150
• queryStringToObject: queryStringToObject
Defined in src/utilities/route-utils.ts:151
• replacePathParams: replacePathParams
Defined in src/utilities/route-utils.ts:152
Defined in src/utilities/scroll-utils.ts:91
• scrollToElementById: _scrollToElementById = _scrollToElementById
Defined in src/utilities/scroll-utils.ts:92
• scrollToHash: _scrollToHash = _scrollToHash
Defined in src/utilities/scroll-utils.ts:93
Defined in src/utilities/service-utils.ts:159
• configure: _configure = _configure
Defined in src/utilities/service-utils.ts:160
• configureCultureCode: _configureCultureCode = _configureCultureCode
Defined in src/utilities/service-utils.ts:161
• mapAxiosResponse: _mapAxiosResponse = _mapAxiosResponse
Defined in src/utilities/service-utils.ts:162
• mapPagedAxiosResponse: _mapPagedAxiosResponse = _mapPagedAxiosResponse
Defined in src/utilities/service-utils.ts:163
Defined in src/utilities/string-utils.ts:264
• camelCase: camelCase
Defined in src/utilities/string-utils.ts:265
• capitalize: capitalize
Defined in src/utilities/string-utils.ts:266
• filename: filename
Defined in src/utilities/string-utils.ts:267
• hasValue: hasValue
Defined in src/utilities/string-utils.ts:268
• isEmpty: isEmpty
Defined in src/utilities/string-utils.ts:269
• isValidCultureCode: isValidCultureCode
Defined in src/utilities/string-utils.ts:270
• isValidEmail: isValidEmail
Defined in src/utilities/string-utils.ts:271
• join: join
Defined in src/utilities/string-utils.ts:272
• lowerFirst: lowerFirst
Defined in src/utilities/string-utils.ts:273
• pad: pad
Defined in src/utilities/string-utils.ts:274
• padEnd: padEnd
Defined in src/utilities/string-utils.ts:275
• padStart: padStart
Defined in src/utilities/string-utils.ts:276
• pluralize: pluralize
Defined in src/utilities/string-utils.ts:277
• repeat: repeat
Defined in src/utilities/string-utils.ts:278
• snakeCase: snakeCase
Defined in src/utilities/string-utils.ts:279
• startCase: startCase
Defined in src/utilities/string-utils.ts:280
• template: template
Defined in src/utilities/string-utils.ts:281
• truncateRight: truncateRight
Defined in src/utilities/string-utils.ts:282
• upperFirst: upperFirst
Defined in src/utilities/string-utils.ts:283
• words: words
Defined in src/utilities/string-utils.ts:284
Defined in src/utilities/localization-utils.ts:34
• debug: boolean = EnvironmentUtils.isDevelopment()
Defined in src/utilities/localization-utils.ts:35
• detection: DetectorOptions = detectionOptions
Defined in src/utilities/localization-utils.ts:36
• escapeValue: false = false
Defined in src/utilities/localization-utils.ts:37
Defined in src/view-models/result-error-record.ts:5
Defined in src/view-models/result-record.ts:8
• errors: undefined = undefined
Defined in src/view-models/result-record.ts:9
• key: undefined = undefined
Defined in src/view-models/result-error-record.ts:6
• message: undefined = undefined
Defined in src/view-models/result-error-record.ts:7
• resultObject: undefined = undefined
Defined in src/view-models/result-record.ts:10
• type: Error = ErrorType.Error
Defined in src/view-models/result-error-record.ts:8
Defined in src/utilities/localization-utils.ts:28
Defaults detection options for i18next-browser-languageDetector
• lookupFromPathIndex: number = 0
Defined in src/utilities/localization-utils.ts:29
• lookupQuerystring: string = routeParam
Defined in src/utilities/localization-utils.ts:30
• order: string[] = ["path", "querystring"]
Defined in src/utilities/localization-utils.ts:31