Readme - Serenity Guide

@serenity-is/corelib

Serenity Core Library

This is the package containing core TypeScript classes and functions used in Serenity applications.

It should be installed by default in your projects created from Serene or StartSharp template:

{
  "dependencies": {
    // ...
    "@serenity-is/corelib": "latest"
  }
}

The version number for this package should be equal or as close as possible to Serenity NuGet package versions in your project file.

When using classic namespaces instead of the ESM modules, the types and functions in this module are directly available from the global Serenity and Q namespaces. e.g. Serenity.EntityGrid

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AnyIconClass

Ƭ AnyIconClass: KnownIconClass | string &

Defined in

src/base/icons.ts:21

CancellableViewCallback

Ƭ CancellableViewCallback<TEntity>: (view: RemoteView<TEntity>) => boolean | void

Type parameters

Name
`TEntity`

Type declaration

▸ (view): boolean | void

Parameters

Name	Type
`view`	`RemoteView`<`TEntity`>

Returns

boolean | void

Defined in

src/slick/remoteview.ts:38

ClassTypeInfo

Ƭ ClassTypeInfo<T>: TypeInfo<T>

Type parameters

Name
`T`

Defined in

src/base/system.ts:279

ComboboxFormatResult

Ƭ ComboboxFormatResult: string | Element | DocumentFragment

Defined in

src/ui/editors/combobox.ts:5

ComboboxType

Ƭ ComboboxType: "select2"

Defined in

src/ui/editors/combobox.ts:4

Constructor

Ƭ Constructor<T>: (...args: any[]) => T

Type parameters

Name
`T`

Type declaration

• (...args): T

Parameters

Name	Type
`...args`	`any`[]

Returns

T

Defined in

src/index.ts:98

DialogType

Ƭ DialogType: "bsmodal" | "uidialog" | "panel"

Defined in

src/base/dialogs.ts:28

Dictionary

Ƭ Dictionary<TItem>: Object

Type parameters

Name
`TItem`

Index signature

▪ [key: string]: TItem

Defined in

src/q/system-compat.ts:3

EditorProps

Ƭ EditorProps<T>: WidgetProps<T> & { initialValue?: any ; maxLength?: number ; name?: string ; placeholder?: string ; readOnly?: boolean ; required?: boolean }

Type parameters

Name
`T`

Defined in

src/ui/widgets/widgetutils.ts:129

EditorTypeInfo

Ƭ EditorTypeInfo<T>: TypeInfo<T>

Type parameters

Name
`T`

Defined in

src/base/system.ts:280

Format

Ƭ Format<TItem>: (ctx: FormatterContext<TItem>) => FormatterResult

Type parameters

Name	Type
`TItem`	`any`

Type declaration

▸ (ctx): FormatterResult

Parameters

Name	Type
`ctx`	`FormatterContext`<`TItem`>

Returns

FormatterResult

Defined in

src/slick/slicktypes.ts:4

FormatterTypeInfo

Ƭ FormatterTypeInfo<T>: TypeInfo<T>

Type parameters

Name
`T`

Defined in

src/base/system.ts:281

GroupByElement

Ƭ GroupByElement<TItem>: Object

A group item returned by groupBy().

Type parameters

Name
`TItem`

Type declaration

Name	Type	Description
`items`	`TItem`[]	the items in the group
`key`	`string`	key of the group
`order`	`number`	index of the item in `inOrder` array
`start`	`number`	index of the first item of this group in the original array

Defined in

src/q/arrays-compat.ts:43

GroupByResult

Ƭ GroupByResult<TItem>: Object

Return type of the groupBy function.

Type parameters

Name
`TItem`

Type declaration

Name	Type
`byKey`	{ `[key: string]`: `GroupByElement`<`TItem`>; }
`inOrder`	`GroupByElement`<`TItem`>[]

Defined in

src/q/arrays-compat.ts:57

Grouping

Ƭ Grouping<TItem>: Object

Type parameters

Name
`TItem`

Index signature

▪ [key: string]: TItem[]

IdPrefixType

Ƭ IdPrefixType: Object

Index signature

▪ [key: string]: string

Type declaration

Name	Type
`Form`	`string`
`PropertyGrid`	`string`
`Tabs`	`string`
`Toolbar`	`string`

Defined in

src/ui/widgets/widgetutils.ts:108

InterfaceTypeInfo

Ƭ InterfaceTypeInfo<T>: TypeInfo<T>

Type parameters

Name
`T`

Defined in

src/base/system.ts:282

KnownIconClass

Ƭ KnownIconClass: `fa fa-$\{faIconKey}\` \| \`fab fa-${fabIconKey}`

Defined in

src/base/icons.ts:20

NoInfer

Ƭ NoInfer<T>: [T][T extends any ? 0 : never]

Type parameters

Name
`T`

Defined in

src/base/system.ts:211

NotifyMap

Ƭ NotifyMap: Object

Type declaration

Name	Type
`iconClass`	`string`
`message?`	`string`
`title?`	`string`
`type`	`string`

Defined in

src/base/toastr2.ts:39

RemoteViewAjaxCallback

Ƭ RemoteViewAjaxCallback<TEntity>: (view: RemoteView<TEntity>, options: ServiceOptions<ListResponse<TEntity>>) => boolean | void

Type parameters

Name
`TEntity`

Type declaration

▸ (view, options): boolean | void

Parameters

Name	Type
`view`	`RemoteView`<`TEntity`>
`options`	`ServiceOptions`<`ListResponse`<`TEntity`>>

Returns

boolean | void

Defined in

src/slick/remoteview.ts:39

RemoteViewFilter

Ƭ RemoteViewFilter<TEntity>: (item: TEntity, view: RemoteView<TEntity>) => boolean

Type parameters

Name
`TEntity`

Type declaration

▸ (item, view): boolean

Parameters

Name	Type
`item`	`TEntity`
`view`	`RemoteView`<`TEntity`>

Returns

boolean

Defined in

src/slick/remoteview.ts:40

RemoteViewProcessCallback

Ƭ RemoteViewProcessCallback<TEntity>: (data: ListResponse<TEntity>, view: RemoteView<TEntity>) => ListResponse<TEntity>

Type parameters

Name
`TEntity`

Type declaration

▸ (data, view): ListResponse<TEntity>

Parameters

Name	Type
`data`	`ListResponse`<`TEntity`>
`view`	`RemoteView`<`TEntity`>

Returns

ListResponse<TEntity>

Defined in

src/slick/remoteview.ts:41

Select2Element

Ƭ Select2Element: HTMLInputElement | HTMLSelectElement

Defined in

src/ui/editors/select2.ts:7

Select2FormatResult

Ƭ Select2FormatResult: string | Element | DocumentFragment

Defined in

src/ui/editors/select2.ts:8

StringLiteral

Ƭ StringLiteral<T>: T extends string ? string extends T ? never : T : never

Type parameters

Name
`T`

Defined in

src/base/system-internal.ts:23

TextColor

Defined in

src/base/icons.ts:2

ToastContainerOptions

Ƭ ToastContainerOptions: Object

Type declaration

Name	Type
`containerId?`	`string`
`positionClass?`	`string`
`target?`	`string`

Defined in

src/base/toastr2.ts:4

ToastrOptions

Ƭ ToastrOptions: ToastContainerOptions & { closeButton?: boolean ; closeClass?: string ; closeDuration?: number | false ; closeEasing?: boolean ; closeHtml?: string ; closeMethod?: boolean ; closeOnHover?: boolean ; escapeHtml?: boolean ; extendedTimeOut?: number ; hideDuration?: number ; iconClass?: string ; messageClass?: string ; newestOnTop?: boolean ; onCloseClick?: (event: Event) => void ; onHidden?: () => void ; onShown?: () => void ; onclick?: (event: MouseEvent) => void ; positionClass?: string ; preventDuplicates?: boolean ; rtl?: boolean ; showDuration?: number ; tapToDismiss?: boolean ; target?: string ; timeOut?: number ; titleClass?: string ; toastClass?: string }

Defined in

src/base/toastr2.ts:10

Type

Ƭ Type: Function | Object

Defined in

src/base/system.ts:17

TypeInfo

Ƭ TypeInfo<T>: Object

Type parameters

Name
`T`

Type declaration

Name	Type
`customAttributes?`	`any`[]
`enumFlags?`	`boolean`
`interfaces?`	`any`[]
`registered?`	`boolean`
`typeKind`	`"class"` \| `"enum"` \| `"interface"` \| `"editor"` \| `"formatter"`
`typeName`	`StringLiteral`<`T`> \| `string` &

Defined in

src/base/system-internal.ts:25

UtilityColor

Defined in

src/base/icons.ts:1

ValidateEventDelegate

Ƭ ValidateEventDelegate: (element: ValidatableElement, event: Event, validator: Validator) => void

Type declaration

▸ (element, event, validator): void

Parameters

Name	Type
`element`	`ValidatableElement`
`event`	`Event`
`validator`	`Validator`

Returns

void

Defined in

src/base/validator.ts:52

ValidationErrorList

Ƭ ValidationErrorList: ValidationErrorItem[]

Defined in

src/base/validator.ts:44

ValidationProvider

Ƭ ValidationProvider: (value: ValidationValue, element: ValidatableElement, params?: any) => boolean | string | Promise<boolean | string>

Validation plugin signature with multitype return. Boolean return signifies the validation result, which uses the default validation error message read from the element attribute. String return signifies failed validation, which then will be used as the validation error message. Promise return signifies asynchronous plugin behavior, with same behavior as Boolean or String.

Type declaration

▸ (value, element, params?): boolean | string | Promise<boolean | string>

Parameters

Name	Type
`value`	`ValidationValue`
`element`	`ValidatableElement`
`params?`	`any`

Returns

boolean | string | Promise<boolean | string>

Defined in

src/base/validator.ts:32

ValidationRules

Ƭ ValidationRules: Record<string, any>

Defined in

src/base/validator.ts:46

ValidationValue

Ƭ ValidationValue: string | string[] | number | boolean

Defined in

src/base/validator.ts:24

WidgetProps

Ƭ WidgetProps<P>: { class?: string ; element?: (el: HTMLElement) => void | HTMLElement | ArrayLike<HTMLElement> | string ; id?: string } & NoInfer<P>

Type parameters

Name
`P`

Defined in

src/ui/widgets/widgetutils.ts:123

faIconKey

Defined in

src/base/icons.ts:41

fabIconKey

Defined in

src/base/icons.ts:142

Variables

Config

• Config: Object

Type declaration

Name	Type	Description
`applicationPath`	`string`	This is the root path of your application. If your application resides under http://localhost/mysite/, your root path is "/mysite/". This variable is automatically initialized by reading from a element with ID "ApplicationPath" from current page, which is usually located in your _LayoutHead.cshtml file
`emailAllowOnlyAscii`	`boolean`	Email validation by default only allows ASCII characters. Set this to true if you want to allow unicode.
`notLoggedInHandler`	`Function`	This is an optional method for handling when user is not logged in. If a users session is expired and when a NotAuthorized response is received from a service call, Serenity will call this handler, so you may intercept it and notify user about this situation and ask if she wants to login again...
`rootNamespaces`	`string`[]	This is the list of root namespaces that may be searched for types. For example, if you specify an editor type of "MyEditor", first a class with name "MyEditor" will be searched, if not found, search will be followed by "Serenity.MyEditor" and "MyApp.MyEditor" if you added "MyApp" to the list of root namespaces. You should usually add your application root namespace to this list in ScriptInit(ialization).ts file.

Defined in

src/base/config.ts:1

Culture

• Culture: Locale

Current culture, e.g. CultureInfo.CurrentCulture. This is overridden by settings passed from a <script> element in the page with id ScriptCulture containing a JSON object if available. This element is generally created in the _LayoutHead.cshtml file for Serenity applications, so that the culture settings determined server, can be passed to the client.

Defined in

src/base/formatting.ts:130

Invariant

• Invariant: Locale

Invariant locale (e.g. CultureInfo.InvariantCulture)

Defined in

src/base/formatting.ts:62

defaultNotifyOptions

• defaultNotifyOptions: ToastrOptions

Defined in

src/base/notify.ts:3

typeInfoProperty

• Const typeInfoProperty: "typeInfo"

Defined in

src/base/system-internal.ts:3

Functions

Criteria

▸ Criteria(field): CriteriaBuilder

Creates a new criteria builder containg the passed field name.

Parameters

Name	Type	Description
`field`	`string`	The field name.

Returns

CriteriaBuilder

Defined in

src/base/criteria.ts:750

Fluent

▸ Fluent<K>(tag): Fluent<HTMLElementTagNameMap[K]>

Type parameters

Name	Type
`K`	extends keyof `HTMLElementTagNameMap`

Parameters

Name	Type
`tag`	`K`

Returns

Fluent<HTMLElementTagNameMap[K]>

Defined in

src/base/fluent.ts:408

▸ Fluent<TElement>(element): Fluent<TElement>

Type parameters

Name	Type
`TElement`	extends `HTMLElement`

Parameters

Name	Type
`element`	`TElement`

Returns

Fluent<TElement>

Defined in

src/base/fluent.ts:409

▸ Fluent(element): Fluent<HTMLElement>

Parameters

Name	Type
`element`	`EventTarget`

Returns

Fluent<HTMLElement>

Defined in

src/base/fluent.ts:410

GridPageInit

▸ GridPageInit<TGrid, P>(«destructured»): HTMLElement

Type parameters

Name	Type
`TGrid`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`«destructured»`	`Object`
› `props?`	`WidgetProps`<`P`>
› `type`	(`options?`: `P`) => `TGrid`
› `type.prototype`	`TGrid`

Returns

HTMLElement

Defined in

src/q/layout.ts:38

PanelPageInit

▸ PanelPageInit<TPanel, P>(«destructured»): HTMLElement

Type parameters

Name	Type
`TPanel`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`«destructured»`	`Object`
› `props?`	`WidgetProps`<`P`>
› `type`	(`options?`: `P`) => `TPanel`
› `type.prototype`	`TPanel`

Returns

HTMLElement

Defined in

src/q/layout.ts:42

ToolbarButton

▸ ToolbarButton(tb): HTMLElement

Parameters

Name	Type
`tb`	`ToolButtonProps`

Returns

HTMLElement

Defined in

src/ui/widgets/toolbar.ts:28

addClass

▸ addClass(el, cls): void

Parameters

Name	Type
`el`	`Element`
`cls`	`string`

Returns

void

Defined in

src/base/html.ts:48

addCustomAttribute

▸ addCustomAttribute(type, attr): void

Parameters

Name	Type
`type`	`any`
`attr`	`any`

Returns

void

Defined in

src/base/system.ts:229

addEmptyOption

▸ addEmptyOption(select): void

Adds an empty option to the select.

Parameters

Name	Type	Description
`select`	`HTMLSelectElement` \| `ArrayLike`<`HTMLElement`>	the select element

Returns

void

Defined in

src/q/html-compat.ts:7

addLocalText

▸ addLocalText(obj, pre?): void

Parameters

Name	Type
`obj`	`string` \| `Record`<`string`, `string` \| `Record`<`string`, `any`>>
`pre?`	`string`

Returns

void

Defined in

src/base/localtext.ts:11

addOption

▸ addOption(select, key, text): void

Adds an option to the select.

Parameters

Name	Type
`select`	`HTMLSelectElement` \| `ArrayLike`<`HTMLElement`>
`key`	`string`
`text`	`string`

Returns

void

Defined in

src/q/html-compat.ts:14

addTypeMember

▸ addTypeMember(type, member): TypeMember

Parameters

Name	Type
`type`	`any`
`member`	`TypeMember`

Returns

TypeMember

Defined in

src/q/system-compat.ts:119

addValidationRule

▸ addValidationRule(element, rule, uniqueName?): void

Parameters

Name	Type
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>
`rule`	(`input`: `ValidatableElement`) => `string`
`uniqueName?`	`string`

Returns

void

Defined in

src/base/validator.ts:1669

alert

▸ alert(message, options?): Partial<Dialog>

Parameters

Name	Type
`message`	`string`
`options?`	`MessageDialogOptions`

Returns

Partial<Dialog>

Deprecated

use alertDialog

Defined in

src/q/dialogs-compat.ts:4

alertDialog

▸ alertDialog(message, options?): Partial<Dialog>

Displays an alert dialog

Parameters

Name	Type	Description
`message`	`string`	The message to display
`options?`	`MessageDialogOptions`	Additional options.

Returns

Partial<Dialog>

See

AlertOptions

Example

alertDialog("An error occured!"); }

Defined in

src/base/dialogs.ts:805

any

▸ any<TItem>(array, predicate): boolean

Tests if any of array elements matches given predicate. Prefer Array.some() over this function (e.g. [1, 2, 3].some(predicate)).

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

boolean

True if any element matches.

Defined in

src/q/arrays-compat.ts:7

appendChild

▸ appendChild(child, node): void

Appends child at first argument to given node at second argument. From https://github.com/alex-kinokon/jsx-dom.

Parameters

Name	Type	Description
`child`	`any`	Child element or elements
`node`	`HTMLElement`	Target parent element

Returns

void

Defined in

src/q/html-compat.ts:102

associateWidget

▸ associateWidget(widget): void

Parameters

Name	Type
`widget`	`Object`
`widget.domNode`	`HTMLElement`

Returns

void

Defined in

src/ui/widgets/widgetutils.ts:9

attrEncode

▸ attrEncode(s): string

Parameters

Name	Type
`s`	`any`

Returns

string

Deprecated

use htmlEncode as it also encodes quotes

Defined in

src/q/html-compat.ts:22

bgColor

▸ bgColor(color): string

Parameters

Name	Type
`color`	`UtilityColor`

Returns

string

Defined in

src/base/icons.ts:4

blockUI

▸ blockUI(options?): void

Tries to block the page

Parameters

Name	Type
`options?`	`Object`
`options.useTimeout?`	`boolean`
`options.zIndex?`	`number`

Returns

void

Defined in

src/base/blockui.ts:6

blockUndo

▸ blockUndo(): void

Unblocks the page.

Returns

void

Defined in

src/base/blockui.ts:25

canLoadScriptData

▸ canLoadScriptData(name): boolean

Check if a dynamic script with provided name is available in the cache or it is a registered script name

Parameters

Name	Type	Description
`name`	`string`	Dynamic script name

Returns

boolean

True if already available or registered

Defined in

src/q/scriptdata-compat.ts:78

cancelDialogButton

▸ cancelDialogButton(opt?): DialogButton

Parameters

Name	Type
`opt?`	`DialogButton`

Returns

DialogButton

Defined in

src/base/dialogs.ts:580

cast

▸ cast(instance, type): any

Parameters

Name	Type
`instance`	`any`
`type`	`Type`

Returns

any

Defined in

src/q/system-compat.ts:189

centerDialog

▸ centerDialog(el): void

Parameters

Name	Type
`el`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>

Returns

void

Defined in

src/q/layout.ts:152

classTypeInfo

▸ classTypeInfo<T>(typeName, interfaces?): ClassTypeInfo<T>

Type parameters

Name
`T`

Parameters

Name	Type
`typeName`	`StringLiteral`<`T`>
`interfaces?`	`any`[]

Returns

ClassTypeInfo<T>

Defined in

src/base/system.ts:284

clearKeys

▸ clearKeys(d): void

Parameters

Name	Type
`d`	`any`

Returns

void

Defined in

src/q/system-compat.ts:178

clearOptions

▸ clearOptions(select): void

Clears the options in the select element

Parameters

Name	Type
`select`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>

Returns

void

Defined in

src/q/html-compat.ts:25

coalesce

▸ coalesce(a, b): any

Parameters

Name	Type
`a`	`any`
`b`	`any`

Returns

any

Deprecated

Use ?? operator

Defined in

src/q/system-compat.ts:6

compareStringFactory

▸ compareStringFactory(order): (a: string, b: string) => number

Factory for a function that compares two strings, based on a character order passed in the order argument.

Parameters

Name	Type
`order`	`string`

Returns

fn

▸ (a, b): number

Parameters

Name	Type
`a`	`string`
`b`	`string`

Returns

number

Defined in

src/base/formatting.ts:90

confirm

▸ confirm(message, onYes, options?): Partial<Dialog>

Parameters

Name	Type
`message`	`string`
`onYes`	() => `void`
`options?`	`ConfirmDialogOptions`

Returns

Partial<Dialog>

Deprecated

use confirmDialog

Defined in

src/q/dialogs-compat.ts:7

confirmDialog

▸ confirmDialog(message, onYes, options?): Partial<Dialog>

Display a confirmation dialog

Parameters

Name	Type	Description
`message`	`string`	The message to display
`onYes`	() => `void`	Callback for Yes button click
`options?`	`ConfirmDialogOptions`	Additional options.

Returns

Partial<Dialog>

See

ConfirmOptions

Example

confirmDialog("Are you sure you want to delete?", () => { 
    // do something when yes is clicked
}

Defined in

src/base/dialogs.ts:840

count

▸ count<TItem>(array, predicate): number

Counts number of array elements that matches a given predicate.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

number

Defined in

src/q/arrays-compat.ts:16

dbText

▸ dbText(prefix): (key: string) => string

Parameters

Name	Type
`prefix`	`string`

Returns

fn

▸ (key): string

Parameters

Name	Type
`key`	`string`

Returns

string

Defined in

src/q/localtext-compat.ts:6

dbTryText

▸ dbTryText(prefix): (key: string) => string

Parameters

Name	Type
`prefix`	`string`

Returns

fn

▸ (key): string

Parameters

Name	Type
`key`	`string`

Returns

string

Defined in

src/q/localtext-compat.ts:39

deassociateWidget

▸ deassociateWidget(widget): void

Parameters

Name	Type
`widget`	`Object`
`widget.domNode`	`HTMLElement`

Returns

void

Defined in

src/ui/widgets/widgetutils.ts:28

debounce

▸ debounce<T>(func, wait?, immediate?): DebouncedFunction<T>

Returns a function, that, as long as it continues to be invoked, will not be triggered. The function also has a property 'clear' that can be used to clear the timer to prevent previously scheduled executions, and flush method to invoke scheduled executions now if any.

Type parameters

Name	Type
`T`	extends (...`args`: `any`) => `any`

Parameters

Name	Type	Description
`func`	`T`	-
`wait?`	`number`	The function will be called after it stops being called for N milliseconds.
`immediate?`	`boolean`	If passed, trigger the function on the leading edge, instead of the trailing.

Returns

DebouncedFunction<T>

Source

underscore.js

Defined in

src/base/debounce.ts:39

deepClone

▸ deepClone<T>(a, a2?, a3?): T

Type parameters

Name	Type
`T`	`any`

Parameters

Name	Type
`a`	`T`
`a2?`	`any`
`a3?`	`any`

Returns

T

Defined in

src/q/system-compat.ts:27

delegateCombine

▸ delegateCombine(delegate1, delegate2): any

Parameters

Name	Type
`delegate1`	`any`
`delegate2`	`any`

Returns

any

Defined in

src/ui/filtering/filterstore.ts:195

delegateContains

▸ delegateContains(targets, object, method): boolean

Parameters

Name	Type
`targets`	`any`[]
`object`	`any`
`method`	`any`

Returns

boolean

Defined in

src/ui/filtering/filterstore.ts:248

delegateRemove

▸ delegateRemove(delegate1, delegate2): any

Parameters

Name	Type
`delegate1`	`any`
`delegate2`	`any`

Returns

any

Defined in

src/ui/filtering/filterstore.ts:215

editorTypeInfo

▸ editorTypeInfo<T>(typeName, interfaces?): EditorTypeInfo<T>

Type parameters

Name
`T`

Parameters

Name	Type
`typeName`	`StringLiteral`<`T`>
`interfaces?`	`any`[]

Returns

EditorTypeInfo<T>

Defined in

src/base/system.ts:288

endsWith

▸ endsWith(s, suffix): boolean

Checks if the string ends with the specified substring.

Parameters

Name	Type	Description
`s`	`string`	String to check.
`suffix`	`string`	Suffix to check.

Returns

boolean

True if the string ends with the specified substring.

Deprecated

Use .endsWith method of String directly

Defined in

src/q/strings-compat.ts:8

executeEverytimeWhenVisible

▸ executeEverytimeWhenVisible(el, callback, callNowIfVisible): void

Parameters

Name	Type
`el`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>
`callback`	`Function`
`callNowIfVisible`	`boolean`

Returns

void

Defined in

src/q/layouttimer.ts:153

executeOnceWhenVisible

▸ executeOnceWhenVisible(el, callback): void

Parameters

Name	Type
`el`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>
`callback`	`Function`

Returns

void

Defined in

src/q/layouttimer.ts:140

extend

▸ extend<T>(a, b): T

Type parameters

Name	Type
`T`	`any`

Parameters

Name	Type
`a`	`T`
`b`	`T`

Returns

T

Defined in

src/q/system-compat.ts:20

faIcon

▸ faIcon(key, color?): string

Parameters

Name	Type
`key`	`faIconKey`
`color?`	`TextColor`

Returns

string

Defined in

src/base/icons.ts:12

fabIcon

▸ fabIcon(key, color?): string

Parameters

Name	Type
`key`	`fabIconKey`
`color?`	`TextColor`

Returns

string

Defined in

src/base/icons.ts:16

fetchScriptData

▸ fetchScriptData<TData>(name): Promise<TData>

Fetches a script data with given name via ~/DynamicData endpoint

Type parameters

Name
`TData`

Parameters

Name	Type	Description
`name`	`string`	Dynamic script name

Returns

Promise<TData>

A promise that will return data if successfull

Defined in

src/base/scriptdata.ts:54

fieldsProxy

▸ fieldsProxy<TRow>(): Readonly<Record<keyof TRow, string>>

Type parameters

Name
`TRow`

Returns

Readonly<Record<keyof TRow, string>>

Defined in

src/base/system.ts:199

findElementWithRelativeId

▸ findElementWithRelativeId(element, relativeId, context?): HTMLElement

Finds the first element with the given relative id to the source element. It can handle underscores in the source element id.

Parameters

Name	Type	Description
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>	the source element
`relativeId`	`string`	the relative id to the source element
`context?`	`HTMLElement`	the context element (optional)

Returns

HTMLElement

the element with the given relative id to the source element.

Defined in

src/q/html-compat.ts:39

first

▸ first<TItem>(array, predicate): TItem

Gets first element in an array that matches given predicate similar to LINQ's First. Throws an error if no match is found.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

TItem

First element that matches.

Defined in

src/q/arrays-compat.ts:32

format

▸ format(format, ...prm): string

Parameters

Name	Type
`format`	`string`
`...prm`	`any`[]

Returns

string

Deprecated

Use stringFormat

Defined in

src/q/formatting-compat.ts:28

formatDate

▸ formatDate(d, format?, locale?): string

Formats a date using the specified format string and optional culture. Supports .NET style format strings including custom formats. See .NET documentation for supported formats.

Parameters

Name	Type	Description
`d`	`string` \| `Date`	the date to format. If null, it returns empty string.
`format?`	`string`	the format string to use. If null, it uses the current culture's default format. 'G' uses the culture's datetime format. 'g' uses the culture's datetime format with secs removed. 'd' uses the culture's date format. 't' uses the culture's time format. 'u' uses the sortable ISO format with UTC time. 'U' uses the culture's date format with UTC time.
`locale?`	`Locale`	the locale to use

Returns

string

the formatted date

Example

// returns "2019-01-01"
formatDate(new Date(2019, 0, 1), "yyyy-MM-dd");

Example

// returns "2019-01-01 12:00:00"
formatDate(new Date(2019, 0, 1, 12), "yyyy-MM-dd HH:mm:ss");

Example

// returns "2019-01-01 12:00:00.000"
formatDate(new Date(2019, 0, 1, 12), "yyyy-MM-dd HH:mm:ss.fff");

Example

// returns "2019-01-01 12:00:00.000 AM"
formatDate(new Date(2019, 0, 1, 12), "yyyy-MM-dd HH:mm:ss.fff tt");

Defined in

src/base/formatting.ts:644

formatDayHourAndMin

▸ formatDayHourAndMin(n): string

Formats a number containing number of minutes into a string in the format "d.hh:mm".

Parameters

Name	Type	Description
`n`	`number`	The number of minutes.

Returns

string

Defined in

src/q/formatting-compat.ts:37

formatISODateTimeUTC

▸ formatISODateTimeUTC(d): string

Formats a date as the ISO 8601 UTC date/time format.

Parameters

Name	Type	Description
`d`	`Date`	The date.

Returns

string

Defined in

src/base/formatting.ts:818

formatNumber

▸ formatNumber(num, format?, decOrLoc?, grp?): string

Formats a number using the current Culture locale (or the passed locale) settings. It supports format specifiers similar to .NET numeric formatting strings.

Parameters

Name	Type	Description
`num`	`number`	the number to format
`format?`	`string`	the format specifier. default is 'g'. See .NET numeric formatting strings documentation for more information.
`decOrLoc?`	`string` \| `NumberFormat`	-
`grp?`	`string`	-

Returns

string

Defined in

src/base/formatting.ts:291

formatterTypeInfo

▸ formatterTypeInfo<T>(typeName, interfaces?): FormatterTypeInfo<T>

Type parameters

Name
`T`

Parameters

Name	Type
`typeName`	`StringLiteral`<`T`>
`interfaces?`	`any`[]

Returns

FormatterTypeInfo<T>

Defined in

src/base/system.ts:292

getActiveRequests

▸ getActiveRequests(): number

Returns

number

Defined in

src/base/services.ts:98

getBaseType

▸ getBaseType(type): any

Parameters

Name	Type
`type`	`any`

Returns

any

Defined in

src/base/system.ts:91

getColumns

▸ getColumns(key): PropertyItem[]

Parameters

Name	Type
`key`	`string`

Returns

PropertyItem[]

Defined in

src/q/scriptdata-compat.ts:94

getColumnsAsync

▸ getColumnsAsync(key): Promise<PropertyItem[]>

Parameters

Name	Type
`key`	`string`

Returns

Promise<PropertyItem[]>

Defined in

src/q/scriptdata-compat.ts:98

getColumnsData

▸ getColumnsData(key): PropertyItemsData

Parameters

Name	Type
`key`	`string`

Returns

PropertyItemsData

Defined in

src/q/scriptdata-compat.ts:102

getColumnsDataAsync

▸ getColumnsDataAsync(key): Promise<PropertyItemsData>

Gets or loads a [ColumnsScript] data

Parameters

Name	Type	Description
`key`	`string`	Form key

Returns

Promise<PropertyItemsData>

A property items data object containing items and additionalItems properties

Defined in

src/q/scriptdata-compat.ts:106

getColumnsScript

▸ getColumnsScript(key): Promise<PropertyItemsData>

Gets or loads a [ColumnsScript] data

Parameters

Name	Type	Description
`key`	`string`	Form key

Returns

Promise<PropertyItemsData>

A property items data object containing items and additionalItems properties

Defined in

src/base/scriptdata.ts:129

getCookie

▸ getCookie(name): any

Parameters

Name	Type
`name`	`string`

Returns

any

Defined in

src/base/services.ts:33

getCustomAttribute

▸ getCustomAttribute<TAttr>(type, attrType, inherit?): TAttr

Type parameters

Name
`TAttr`

Parameters

Name	Type	Default value
`type`	`any`	`undefined`
`attrType`	(...`args`: `any`[]) => `TAttr`	`undefined`
`inherit`	`boolean`	`true`

Returns

TAttr

Defined in

src/base/system.ts:237

getCustomAttributes

▸ getCustomAttributes<TAttr>(type, attrType, inherit?): TAttr[]

Type parameters

Name
`TAttr`

Parameters

Name	Type	Default value
`type`	`any`	`undefined`
`attrType`	(...`args`: `any`[]) => `TAttr`	`undefined`
`inherit`	`boolean`	`true`

Returns

TAttr[]

Defined in

src/base/system.ts:258

getForm

▸ getForm(key): PropertyItem[]

Parameters

Name	Type
`key`	`string`

Returns

PropertyItem[]

Defined in

src/q/scriptdata-compat.ts:108

getFormAsync

▸ getFormAsync(key): Promise<PropertyItem[]>

Parameters

Name	Type
`key`	`string`

Returns

Promise<PropertyItem[]>

Defined in

src/q/scriptdata-compat.ts:112

getFormData

▸ getFormData(key): PropertyItemsData

Parameters

Name	Type
`key`	`string`

Returns

PropertyItemsData

Defined in

src/q/scriptdata-compat.ts:116

getFormDataAsync

▸ getFormDataAsync(key): Promise<PropertyItemsData>

Gets or loads a [FormScript] data

Parameters

Name	Type	Description
`key`	`string`	Form key

Returns

Promise<PropertyItemsData>

A property items data object containing items and additionalItems properties

Defined in

src/q/scriptdata-compat.ts:120

getFormScript

▸ getFormScript(key): Promise<PropertyItemsData>

Gets or loads a [FormScript] data

Parameters

Name	Type	Description
`key`	`string`	Form key

Returns

Promise<PropertyItemsData>

A property items data object containing items and additionalItems properties

Defined in

src/base/scriptdata.ts:138

getGlobalObject

▸ getGlobalObject(): any

Returns

any

Defined in

src/base/system.ts:5

getInstanceType

▸ getInstanceType(instance): any

Parameters

Name	Type
`instance`	`any`

Returns

any

Defined in

src/base/system.ts:58

getLookup

▸ getLookup<TItem>(key): Lookup<TItem>

Type parameters

Name
`TItem`

Parameters

Name	Type
`key`	`string`

Returns

Lookup<TItem>

Defined in

src/q/scriptdata-compat.ts:86

getLookupAsync

▸ getLookupAsync<TItem>(key): Promise<Lookup<TItem>>

Gets or loads a Lookup

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`key`	`string`	Lookup key

Returns

Promise<Lookup<TItem>>

Defined in

src/base/scriptdata.ts:146

getMembers

▸ getMembers(type, memberTypes): TypeMember[]

Parameters

Name	Type
`type`	`any`
`memberTypes`	`MemberType`

Returns

TypeMember[]

Defined in

src/q/system-compat.ts:86

getNested

▸ getNested(from, name): any

Parameters

Name	Type
`from`	`any`
`name`	`string`

Returns

any

Defined in

src/base/system.ts:19

getRemoteData

▸ getRemoteData<TData>(key): TData

Type parameters

Name	Type
`TData`	`any`

Parameters

Name	Type
`key`	`string`

Returns

TData

Defined in

src/q/scriptdata-compat.ts:82

getRemoteDataAsync

▸ getRemoteDataAsync<TData>(key): Promise<TData>

Gets or loads a [RemoteData]

Type parameters

Name	Type
`TData`	`any`

Parameters

Name	Type	Description
`key`	`string`	Remote data key

Returns

Promise<TData>

Defined in

src/base/scriptdata.ts:154

getScriptData

▸ getScriptData<TData>(name, reload?): Promise<TData>

Returns the script data from cache if available, or via a fetch request to ~/DynamicData endpoint

Type parameters

Name	Type
`TData`	`any`

Parameters

Name	Type	Description
`name`	`string`
`reload?`	`boolean`	Clear cache and force reload

Returns

Promise<TData>

Defined in

src/base/scriptdata.ts:110

getScriptDataHash

▸ getScriptDataHash(name, reload?): string

Gets the known hash value for a given dynamic script name. They are usually registered server-side via dynamic script manager and their latest known hashes are passed to the client-side via a script element named RegisteredScripts.

Parameters

Name	Type	Description
`name`	`string`	The dynamic script name
`reload?`	`boolean`	True to force resetting the script hash client side, e.g. for loading lookups etc.

Returns

string

The hash or null if no such known registration

Defined in

src/base/scriptdata.ts:19

getTemplate

▸ getTemplate(key): string

Parameters

Name	Type
`key`	`string`

Returns

string

Defined in

src/q/scriptdata-compat.ts:122

getType

▸ getType(name, target?): Type

Parameters

Name	Type
`name`	`string`
`target?`	`any`

Returns

Type

Defined in

src/base/system.ts:29

getTypeFullName

▸ getTypeFullName(type): string

Parameters

Name	Type
`type`	`Type`

Returns

string

Defined in

src/base/system.ts:46

getTypeNameProp

▸ getTypeNameProp(type): string

Parameters

Name	Type
`type`	`any`

Returns

string

Defined in

src/base/system-internal.ts:122

getTypeRegistry

▸ getTypeRegistry(): any

Returns

any

Defined in

src/base/system-internal.ts:34

getTypeShortName

▸ getTypeShortName(type): string

Parameters

Name	Type
`type`	`Type`

Returns

string

Defined in

src/base/system.ts:51

getTypes

▸ getTypes(from?): any[]

Parameters

Name	Type
`from?`	`any`

Returns

any[]

Defined in

src/q/system-compat.ts:153

getWidgetFrom

▸ getWidgetFrom<TWidget>(element, type?): TWidget

Type parameters

Name
`TWidget`

Parameters

Name	Type
`element`	`string` \| `Element` \| `ArrayLike`<`HTMLElement`>
`type?`	(...`args`: `any`[]) => `TWidget`

Returns

TWidget

Defined in

src/ui/widgets/widgetutils.ts:77

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
`type`	`Function`

Returns

string

Defined in

src/ui/widgets/widgetutils.ts:5

getjQuery

▸ getjQuery(): any

Returns

any

Defined in

src/base/environment.ts:1

gridPageInit

▸ gridPageInit<TGrid, P>(grid): TGrid

Type parameters

Name	Type
`TGrid`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`grid`	`TGrid` & { `domNode`: `HTMLElement` }

Returns

TGrid

Defined in

src/q/layout.ts:46

▸ gridPageInit<TGrid, P>(type, props?): TGrid

Type parameters

Name	Type
`TGrid`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`type`	(`options?`: `P`) => `TGrid`
`type.prototype`	`TGrid`
`props?`	`WidgetProps`<`P`>

Returns

TGrid

Defined in

src/q/layout.ts:47

groupBy

▸ groupBy<TItem>(items, getKey): GroupByResult<TItem>

Groups an array with keys determined by specified getKey() callback. Resulting object contains group objects in order and a dictionary to access by key. This is similar to LINQ's ToLookup function with some additional details like start index.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`items`	`TItem`[]	Array to group.
`getKey`	(`x`: `TItem`) => `any`	Function that returns key for each item.

Returns

GroupByResult<TItem>

GroupByResult object.

Defined in

src/q/arrays-compat.ts:70

handleScriptDataError

▸ handleScriptDataError(name, status?, statusText?, shouldThrow?): string

Shows a suitable error message for errors occured during loading of a dynamic script data.

Parameters

Name	Type	Default value	Description
`name`	`string`	`undefined`	Name of the dynamic script
`status?`	`number`	`undefined`	HTTP status returned if available
`statusText?`	`string`	`undefined`	HTTP status text returned if available
`shouldThrow`	`boolean`	`true`	-

Returns

string

Defined in

src/base/scriptdata.ts:165

hasBSModal

▸ hasBSModal(): boolean

Returns

boolean

Defined in

src/base/dialogs.ts:505

hasCustomAttribute

▸ hasCustomAttribute<TAttr>(type, attrType, inherit?): boolean

Type parameters

Name
`TAttr`

Parameters

Name	Type	Default value
`type`	`any`	`undefined`
`attrType`	(...`args`: `any`[]) => `TAttr`	`undefined`
`inherit`	`boolean`	`true`

Returns

boolean

Defined in

src/base/system.ts:254

hasUIDialog

▸ hasUIDialog(): boolean

Returns

boolean

Defined in

src/base/dialogs.ts:509

htmlEncode

▸ htmlEncode(s): string

Html encodes a string (encodes single and double quotes, & (ampersand), > and < characters)

Parameters

Name	Type	Description
`s`	`any`	String (or number etc.) to be HTML encoded

Returns

string

Defined in

src/base/html.ts:18

iconClassName

▸ iconClassName(icon): string

Parameters

Name	Type
`icon`	`IconClassName`

Returns

string

Defined in

src/base/icons.ts:24

iframeDialog

▸ iframeDialog(options): Partial<Dialog>

Display a dialog that shows an HTML block in an IFRAME, which is usually returned from server callbacks

Parameters

Name	Type	Description
`options`	`IFrameDialogOptions`	The options

Returns

Partial<Dialog>

Defined in

src/base/dialogs.ts:949

indexOf

▸ indexOf<TItem>(array, predicate): number

Gets index of first element in an array that matches given predicate.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

number

Defined in

src/q/arrays-compat.ts:103

information

▸ information(message, onOk?, options?): Partial<Dialog>

Parameters

Name	Type
`message`	`string`
`onOk?`	() => `void`
`options?`	`MessageDialogOptions`

Returns

Partial<Dialog>

Deprecated

use informationDialog

Defined in

src/q/dialogs-compat.ts:10

informationDialog

▸ informationDialog(message, onOk?, options?): Partial<Dialog>

Display an information dialog

Parameters

Name	Type	Description
`message`	`string`	The message to display
`onOk?`	() => `void`	Callback for OK button click
`options?`	`MessageDialogOptions`	Additional options.

Returns

Partial<Dialog>

See

ConfirmOptions

Example

informationDialog("Operation complete", () => { 
    // do something when OK is clicked
}

Defined in

src/base/dialogs.ts:877

initFormType

▸ initFormType(typ, nameWidgetPairs): void

Parameters

Name	Type
`typ`	`Function`
`nameWidgetPairs`	`any`[]

Returns

void

Defined in

src/base/system.ts:183

initFullHeightGridPage

▸ initFullHeightGridPage(gridDiv, opt?): void

Parameters

Name	Type
`gridDiv`	`HTMLElement` \| `ArrayLike`<`HTMLElement`> \| { `domNode`: `HTMLElement` }
`opt?`	`Object`
`opt.noRoute?`	`boolean`
`opt.setHeight?`	`boolean`

Returns

void

Defined in

src/q/layout.ts:58

initializeTypes

▸ initializeTypes(root, pre, limit): void

Parameters

Name	Type
`root`	`any`
`pre`	`string`
`limit`	`number`

Returns

void

Defined in

src/q/system-compat.ts:204

insert

▸ insert(obj, index, item): void

Inserts an item to the array at specified index. Prefer Array.splice unless you need to support IE.

Parameters

Name	Type	Description
`obj`	`any`	Array or array like object to insert to.
`index`	`number`	Index to insert at.
`item`	`any`	Item to insert.

Returns

void

Throws

Error if object does not support insert.

Example

insert([1, 2, 3], 1, 4); // [1, 4, 2, 3]
insert({ insert: (index, item) => { this.splice(index, 0, item); } }

Defined in

src/q/arrays-compat.ts:122

interfaceTypeInfo

▸ interfaceTypeInfo<T>(typeName, interfaces?): InterfaceTypeInfo<T>

Type parameters

Name
`T`

Parameters

Name	Type
`typeName`	`StringLiteral`<`T`>
`interfaces?`	`any`[]

Returns

InterfaceTypeInfo<T>

Defined in

src/base/system.ts:296

isArray

▸ isArray(arg): arg is any[]

Determines if the object is an array. Prefer Array.isArray over this function (e.g. Array.isArray(obj)).

Parameters

Name	Type
`arg`	`any`

Returns

arg is any[]

True if the object is an array.

Example

isArray([1, 2, 3]); // true
isArray({}); // false

Defined in

src/q/arrays-compat.ts:139

isArrayLike

▸ isArrayLike(obj): obj is ArrayLike<any>

Parameters

Name	Type
`obj`	`any`

Returns

obj is ArrayLike<any>

Defined in

src/base/system.ts:203

isAssignableFrom

▸ isAssignableFrom(target, type): any

Parameters

Name	Type
`target`	`any`
`type`	`Type`

Returns

any

Defined in

src/base/system.ts:71

isBS3

▸ isBS3(): boolean

Returns true if Bootstrap 3 is loaded

Returns

boolean

Defined in

src/base/environment.ts:7

isBS5Plus

▸ isBS5Plus(): boolean

Returns true if Bootstrap 5+ is loaded

Returns

boolean

Defined in

src/base/environment.ts:12

isEmptyOrNull

▸ isEmptyOrNull(s): boolean

Checks if the string is empty or null. Prefer (!s) instead.

Parameters

Name	Type	Description
`s`	`string`	String to check.

Returns

boolean

True if the string is empty or null.

Defined in

src/q/strings-compat.ts:17

isEnum

▸ isEnum(type): boolean

Parameters

Name	Type
`type`	`any`

Returns

boolean

Defined in

src/base/system.ts:178

isInstanceOfType

▸ isInstanceOfType(instance, type): any

Parameters

Name	Type
`instance`	`any`
`type`	`Type`

Returns

any

Defined in

src/base/system.ts:81

isMobileView

▸ isMobileView(): boolean

Returns

boolean

Defined in

src/q/layout.ts:125

isPromiseLike

▸ isPromiseLike(obj): obj is PromiseLike<any>

Parameters

Name	Type
`obj`	`any`

Returns

obj is PromiseLike<any>

Defined in

src/base/system.ts:207

isSameOrigin

▸ isSameOrigin(url): boolean

Parameters

Name	Type
`url`	`string`

Returns

boolean

Defined in

src/base/services.ts:44

isTrimmedEmpty

▸ isTrimmedEmpty(s): boolean

Checks if the string is empty or null or whitespace. Prefer !s?.Trim() instead.

Parameters

Name	Type	Description
`s`	`string`	String to check.

Returns

boolean

True if the string is empty or null or whitespace.

Defined in

src/q/strings-compat.ts:26

isValue

▸ isValue(a): boolean

Parameters

Name	Type
`a`	`any`

Returns

boolean

Deprecated

Use a != null

Defined in

src/q/system-compat.ts:11

keyOf

▸ keyOf<T>(prop): keyof T

Type parameters

Name
`T`

Parameters

Name	Type
`prop`	keyof `T`

Returns

keyof T

Defined in

src/q/system-compat.ts:185

layoutFillHeight

▸ layoutFillHeight(element): void

Parameters

Name	Type
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>

Returns

void

Defined in

src/q/layout.ts:117

layoutFillHeightValue

▸ layoutFillHeightValue(element): number

Parameters

Name	Type
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>

Returns

number

Defined in

src/q/layout.ts:97

localText

▸ localText(key, defaultText?): string

Parameters

Name	Type
`key`	`string`
`defaultText?`	`string`

Returns

string

Defined in

src/base/localtext.ts:35

localeFormat

▸ localeFormat(l, format, ...prm): string

Parameters

Name	Type
`l`	`Locale`
`format`	`string`
`...prm`	`any`[]

Returns

string

Deprecated

Use stringFormatLocale

Defined in

src/q/formatting-compat.ts:31

newBodyDiv

▸ newBodyDiv(): HTMLDivElement

Creates a new DIV and appends it to the body.

Returns

HTMLDivElement

the new DIV element.

Defined in

src/q/html-compat.ts:81

noDialogButton

▸ noDialogButton(opt?): DialogButton

Parameters

Name	Type
`opt?`	`DialogButton`

Returns

DialogButton

Defined in

src/base/dialogs.ts:571

notifyError

▸ notifyError(message, title?, options?): void

Parameters

Name	Type
`message`	`string`
`title?`	`string`
`options?`	`ToastrOptions`

Returns

void

Defined in

src/base/notify.ts:47

notifyInfo

▸ notifyInfo(message, title?, options?): void

Parameters

Name	Type
`message`	`string`
`title?`	`string`
`options?`	`ToastrOptions`

Returns

void

Defined in

src/base/notify.ts:51

notifySuccess

▸ notifySuccess(message, title?, options?): void

Parameters

Name	Type
`message`	`string`
`title?`	`string`
`options?`	`ToastrOptions`

Returns

void

Defined in

src/base/notify.ts:55

notifyWarning

▸ notifyWarning(message, title?, options?): void

Parameters

Name	Type
`message`	`string`
`title?`	`string`
`options?`	`ToastrOptions`

Returns

void

Defined in

src/base/notify.ts:59

okDialogButton

▸ okDialogButton(opt?): DialogButton

Parameters

Name	Type
`opt?`	`DialogButton`

Returns

DialogButton

Defined in

src/base/dialogs.ts:553

omitUndefined

▸ omitUndefined(x): any

Parameters

Name	Type
`x`	`Object`

Returns

any

Defined in

src/base/system.ts:9

outerHtml

▸ outerHtml(element): string

Returns the outer HTML of the element.

Parameters

Name	Type
`element`	`Element` \| `ArrayLike`<`HTMLElement`>

Returns

string

Defined in

src/q/html-compat.ts:90

padLeft

▸ padLeft(s, len, ch?): any

Pads the string to the left with the specified character.

Parameters

Name	Type	Default value	Description
`s`	`string` \| `number`	`undefined`	String to pad.
`len`	`number`	`undefined`	Target length of the string.
`ch`	`string`	`' '`	Character to pad with.

Returns

any

Padded string.

Defined in

src/q/strings-compat.ts:37

panelPageInit

▸ panelPageInit<TGrid, P>(panel): TGrid

Type parameters

Name	Type
`TGrid`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`panel`	`TGrid` & { `domNode`: `HTMLElement` }

Returns

TGrid

Defined in

src/q/layout.ts:52

▸ panelPageInit<TGrid, P>(type, props?): TGrid

Type parameters

Name	Type
`TGrid`	extends `Widget`<`P`>
`P`	`P`

Parameters

Name	Type
`type`	(`options?`: `P`) => `TGrid`
`type.prototype`	`TGrid`
`props?`	`WidgetProps`<`P`>

Returns

TGrid

Defined in

src/q/layout.ts:53

parseCriteria

▸ parseCriteria(expression, params?): any[]

Parses a criteria expression to Serenity Criteria array format. The string may optionally contain parameters like A >= @p1 and B < @p2.

Parameters

Name	Type	Description
`expression`	`string`	The criteria expression.
`params?`	`any`	The dictionary containing parameter values like { p1: 10, p2: 20 }.

Returns

any[]

Example

parseCriteria('A >=

P1

and B < @p2', { p1: 5, p2: 4 }) // [[[a], '>=' 5], 'and', [[b], '<', 4]]

Defined in

src/base/criteria.ts:694

▸ parseCriteria(strings, ...values): any[]

Parses a criteria expression to Serenity Criteria array format. The expression may contain parameter placeholders like A >= ${p1} where p1 is a variable in the scope.

Parameters

Name	Type	Description
`strings`	`TemplateStringsArray`	The string fragments.
`...values`	`any`[]	The tagged template arguments.

Returns

any[]

Example

var a = 5, b = 4;
parseCriteria`A >= ${a} and B < ${b}` // [[[a], '>=' 5], 'and', [[b], '<', 4]]

Defined in

src/base/criteria.ts:705

parseDate

▸ parseDate(s, dateOrder?): Date

Parses a string to a date. If the string is empty or whitespace, returns null. Returns a NaN Date if the string is not a valid date.

Parameters

Name	Type	Description
`s`	`string`	The string to parse.
`dateOrder?`	`string`	The order of the date parts in the string. Defaults to culture's default date order.

Returns

Date

Defined in

src/base/formatting.ts:862

parseDayHourAndMin

▸ parseDayHourAndMin(s): number

Parses a string in the format "d.hh:mm" into a number containing number of minutes. Returns NaN if the hours not in range 0-23 or minutes not in range 0-59. Returns NULL if the string is empty or whitespace.

Parameters

Name	Type
`s`	`string`

Returns

number

Defined in

src/q/formatting-compat.ts:88

parseDecimal

▸ parseDecimal(s): number

Converts a string to a decimal. The difference between parseFloat and parseDecimal is that parseDecimal will return null if the string is empty or null, whereas parseFloat will return NaN and parseDecimal will use the current culture's group and decimal separators.

Parameters

Name	Type	Description
`s`	`string`	the string to parse

Returns

number

Defined in

src/base/formatting.ts:547

parseHourAndMin

▸ parseHourAndMin(value): number

Parses a time string in the format "hh:mm" into a number containing number of minutes. Returns NaN if the hours not in range 0-23 or minutes not in range 0-59.

Parameters

Name	Type	Description
`value`	`string`	The string to parse.

Returns

number

Defined in

src/q/formatting-compat.ts:61

parseISODateTime

▸ parseISODateTime(s): Date

Parses a string in the ISO 8601 UTC date/time format.

Parameters

Name	Type	Description
`s`	`string`	The string to parse.

Returns

Date

Defined in

src/base/formatting.ts:840

parseInteger

▸ parseInteger(s): number

Converts a string to an integer. The difference between parseInt and parseInteger is that parseInteger will return null if the string is empty or null, whereas parseInt will return NaN and parseInteger will use the current culture's group and decimal separators.

Parameters

Name	Type	Description
`s`	`string`	the string to parse

Returns

number

Defined in

src/base/formatting.ts:525

parseQueryString

▸ parseQueryString(s?): Object

Parameters

Name	Type
`s?`	`string`

Returns

Object

Defined in

src/q/services-compat.ts:23

peekScriptData

▸ peekScriptData(name): any

Parameters

Name	Type
`name`	`string`

Returns

any

Defined in

src/base/scriptdata.ts:213

positionToastContainer

▸ positionToastContainer(options?, create?): void

Parameters

Name	Type	Default value
`options?`	`ToastrOptions`	`undefined`
`create`	`boolean`	`true`

Returns

void

Defined in

src/base/notify.ts:12

postToService

▸ postToService(options): void

Parameters

Name	Type
`options`	`PostToServiceOptions`

Returns

void

Defined in

src/q/services-compat.ts:61

postToUrl

▸ postToUrl(options): void

Parameters

Name	Type
`options`	`PostToUrlOptions`

Returns

void

Defined in

src/q/services-compat.ts:78

prefixedText

▸ prefixedText(prefix): (text: string, key: string | (p?: string) => string) => string

Parameters

Name	Type
`prefix`	`string`

Returns

fn

▸ (text, key): string

Parameters

Name	Type
`text`	`string`
`key`	`string` \| (`p?`: `string`) => `string`

Returns

string

Defined in

src/q/localtext-compat.ts:12

proxyTexts

▸ proxyTexts(o, p, t): Object

Parameters

Name	Type
`o`	`Record`<`string`, `any`>
`p`	`string`
`t`	`Record`<`string`, `any`>

Returns

Object

Defined in

src/base/localtext.ts:43

registerClass

▸ registerClass(type, name, intf?): void

Parameters

Name	Type
`type`	`any`
`name`	`string`
`intf?`	`any`[]

Returns

void

Defined in

src/base/system.ts:111

registerEditor

▸ registerEditor(type, name, intf?): void

Parameters

Name	Type
`type`	`any`
`name`	`string`
`intf?`	`any`[]

Returns

void

Defined in

src/base/system.ts:223

registerEnum

▸ registerEnum(type, name, enumKey?): void

Parameters

Name	Type
`type`	`any`
`name`	`string`
`enumKey?`	`string`

Returns

void

Defined in

src/base/system.ts:116

registerFormatter

▸ registerFormatter(type, name, intf?): void

Parameters

Name	Type
`type`	`any`
`name`	`string`
`intf?`	`any`[]

Returns

void

Defined in

src/base/system.ts:219

registerInterface

▸ registerInterface(type, name, intf?): void

Parameters

Name	Type
`type`	`any`
`name`	`string`
`intf?`	`any`[]

Returns

void

Defined in

src/base/system.ts:126

registerType

▸ registerType(type): void

Parameters

Name	Type
`type`	`Object`
`type.name`	`string`
`type.typeInfo`	`TypeInfo`<`any`>

Returns

void

Defined in

src/base/system.ts:300

reloadLookup

▸ reloadLookup<TItem>(key): Lookup<TItem>

Type parameters

Name	Type
`TItem`	`any`

Parameters

Name	Type
`key`	`string`

Returns

Lookup<TItem>

Defined in

src/q/scriptdata-compat.ts:90

reloadLookupAsync

▸ reloadLookupAsync<TItem>(key): Promise<Lookup<TItem>>

Forces reload of a lookup from the server. Note that only the client side cache is cleared. This does not force reloading in the server-side.

Type parameters

Name	Type
`TItem`	`any`

Parameters

Name	Type	Description
`key`	`string`	Lookup key

Returns

Promise<Lookup<TItem>>

Lookup

Defined in

src/base/scriptdata.ts:223

removeClass

▸ removeClass(el, cls): void

Parameters

Name	Type
`el`	`Element`
`cls`	`string`

Returns

void

Defined in

src/base/html.ts:52

removeValidationRule

▸ removeValidationRule(element, uniqueName): void

Parameters

Name	Type
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>
`uniqueName`	`string`

Returns

void

Defined in

src/base/validator.ts:1683

replaceAll

▸ replaceAll(str, find, replace): string

Replaces all occurrences of the search string with the replacement string.

Parameters

Name	Type	Description
`str`	`string`	String to replace.
`find`	`string`	String to find.
`replace`	`string`	String to replace with.

Returns

string

Replaced string.

Defined in

src/q/strings-compat.ts:113

requestFinished

▸ requestFinished(): void

Returns

void

Defined in

src/base/services.ts:87

requestStarting

▸ requestStarting(): void

Returns

void

Defined in

src/base/services.ts:76

resolveServiceUrl

▸ resolveServiceUrl(url): string

Parameters

Name	Type
`url`	`string`

Returns

string

Defined in

src/base/services.ts:13

resolveUrl

▸ resolveUrl(url): string

Parameters

Name	Type
`url`	`string`

Returns

string

Defined in

src/base/services.ts:7

round

▸ round(n, d?, rounding?): number

Rounds a number to specified digits or an integer number if digits are not specified.

Parameters

Name	Type	Description
`n`	`number`	the number to round
`d?`	`number`	the number of digits to round to. default is zero.
`rounding?`	`boolean`	whether to use banker's rounding

Returns

number

the rounded number

Defined in

src/base/formatting.ts:267

safeCast

▸ safeCast(instance, type): any

Parameters

Name	Type
`instance`	`any`
`type`	`Type`

Returns

any

Defined in

src/q/system-compat.ts:197

serviceCall

▸ serviceCall<TResponse>(options): PromiseLike<TResponse>

Type parameters

Name	Type
`TResponse`	extends `ServiceResponse`

Parameters

Name	Type
`options`	`ServiceOptions`<`TResponse`>

Returns

PromiseLike<TResponse>

Defined in

src/base/services.ts:186

serviceRequest

▸ serviceRequest<TResponse>(service, request?, onSuccess?, options?): PromiseLike<TResponse>

Type parameters

Name	Type
`TResponse`	extends `ServiceResponse`

Parameters

Name	Type
`service`	`string`
`request?`	`any`
`onSuccess?`	(`response`: `TResponse`) => `void`
`options?`	`ServiceOptions`<`TResponse`>

Returns

PromiseLike<TResponse>

Defined in

src/base/services.ts:255

setEquality

▸ setEquality(request, field, value): void

Parameters

Name	Type
`request`	`ListRequest`
`field`	`string`
`value`	`any`

Returns

void

Defined in

src/q/services-compat.ts:3

setRegisteredScripts

▸ setRegisteredScripts(scripts): void

Parameters

Name	Type
`scripts`	`any`[]

Returns

void

Defined in

src/base/scriptdata.ts:227

setScriptData

▸ setScriptData(name, value): void

Parameters

Name	Type
`name`	`string`
`value`	`any`

Returns

void

Defined in

src/base/scriptdata.ts:237

setTypeNameProp

▸ setTypeNameProp(type, value): void

Parameters

Name	Type
`type`	`any`
`value`	`string`

Returns

void

Defined in

src/base/system-internal.ts:126

single

▸ single<TItem>(array, predicate): TItem

Gets first element in an array that matches given predicate. Throws an error if no matches is found, or there are multiple matches.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

TItem

First element that matches.

Example

first([1, 2, 3], x => x == 2); // 2
first([1, 2, 3], x => x == 4); // throws error.

Defined in

src/q/arrays-compat.ts:151

splitDateString

▸ splitDateString(s): string[]

Splits a date string into an array of strings, each containing a single date part. It can handle separators "/", ".", "-" and "".

Parameters

Name	Type	Description
`s`	`string`	The string to split.

Returns

string[]

Defined in

src/base/formatting.ts:936

startsWith

▸ startsWith(s, prefix): boolean

Checks if the string starts with the prefix

Parameters

Name	Type	Description
`s`	`string`	String to check.
`prefix`	`string`	Prefix to check.

Returns

boolean

True if the string starts with the prefix.

Deprecated

Use .startsWith method of String directly

Defined in

src/q/strings-compat.ts:53

stringFormat

▸ stringFormat(format, ...prm): string

Formats a string with parameters similar to .NET's String.Format function using current Culture locale settings.

Parameters

Name	Type
`format`	`string`
`...prm`	`any`[]

Returns

string

Defined in

src/base/formatting.ts:238

stringFormatLocale

▸ stringFormatLocale(l, format, ...prm): string

Formats a string with parameters similar to .NET's String.Format function using the locale passed as the first argument.

Parameters

Name	Type
`l`	`Locale`
`format`	`string`
`...prm`	`any`[]

Returns

string

Defined in

src/base/formatting.ts:246

stripDiacritics

▸ stripDiacritics(str): string

Parameters

Name	Type
`str`	`string`

Returns

string

Defined in

src/ui/editors/combobox.ts:393

success

▸ success(message, onOk?, options?): Partial<Dialog>

Parameters

Name	Type
`message`	`string`
`onOk?`	() => `void`
`options?`	`MessageDialogOptions`

Returns

Partial<Dialog>

Deprecated

use successDialog

Defined in

src/q/dialogs-compat.ts:13

successDialog

▸ successDialog(message, onOk?, options?): Partial<Dialog>

Display a success dialog

Parameters

Name	Type	Description
`message`	`string`	The message to display
`onOk?`	() => `void`	Callback for OK button click
`options?`	`MessageDialogOptions`	Additional options.

Returns

Partial<Dialog>

See

MessageDialogOptions

Example

successDialog("Operation complete", () => { 
    // do something when OK is clicked
}

Defined in

src/base/dialogs.ts:903

text

▸ text(key, defaultText?): string

Parameters

Name	Type
`key`	`string`
`defaultText?`	`string`

Returns

string

Deprecated

prefer localText for better discoverability

Defined in

src/q/localtext-compat.ts:4

textColor

▸ textColor(color): string

Parameters

Name	Type
`color`	`TextColor`

Returns

string

Defined in

src/base/icons.ts:8

toGrouping

▸ toGrouping<TItem>(items, getKey): Grouping<TItem>

Maps an array into a dictionary with keys determined by specified getKey() callback, and values that are arrays containing elements for a particular key.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`items`	`TItem`[]	Array to map.
`getKey`	(`x`: `TItem`) => `any`	Function that returns key for each item.

Returns

Grouping<TItem>

Grouping object.

Example

toGrouping([1, 2, 3], x => x % 2 == 0 ? "even" : "odd"); // { odd: [1, 3], even: [2] }

Defined in

src/q/arrays-compat.ts:180

toId

▸ toId(id): any

Converts a string to an ID. If the string is a number, it is returned as-is. If the string is empty, null or whitespace, null is returned. Otherwise, it is converted to a number if possible. If the string is not a valid number or longer than 14 digits, the trimmed string is returned as-is.

Parameters

Name	Type	Description
`id`	`any`	the string to convert to an ID

Returns

any

Defined in

src/base/formatting.ts:601

toSingleLine

▸ toSingleLine(str): string

Converts the string to single line by removing line end characters

Parameters

Name	Type	Description
`str`	`string`	String to convert.

Returns

string

Defined in

src/q/strings-compat.ts:61

today

▸ today(): Date

Returns

Date

Defined in

src/q/system-compat.ts:15

toggleClass

▸ toggleClass(el, cls, add?): void

Toggles the class on the element handling spaces like addClass does.

Parameters

Name	Type	Description
`el`	`Element`	the element
`cls`	`string`	the class to toggle
`add?`	`boolean`	if true, the class will be added, if false the class will be removed, otherwise it will be toggled.

Returns

void

Defined in

src/base/html.ts:34

triggerLayoutOnShow

▸ triggerLayoutOnShow(element): void

Parameters

Name	Type
`element`	`HTMLElement` \| `ArrayLike`<`HTMLElement`>

Returns

void

Defined in

src/q/layout.ts:143

trim

▸ trim(s): string

Trims the whitespace characters from the start and end of the string This returns empty string even when the string is null or undefined.

Parameters

Name	Type
`s`	`string`

Returns

string

Defined in

src/q/strings-compat.ts:83

trimEnd

▸ trimEnd(s): any

Trims the whitespace characters from the end of the string

Parameters

Name	Type
`s`	`string`

Returns

any

Defined in

src/q/strings-compat.ts:68

trimStart

▸ trimStart(s): any

Trims the whitespace characters from the start of the string

Parameters

Name	Type
`s`	`string`

Returns

any

Defined in

src/q/strings-compat.ts:75

trimToEmpty

▸ trimToEmpty(s): string

Trims the whitespace characters from the start and end of the string Returns empty string if the string is null or undefined.

Parameters

Name	Type
`s`	`string`

Returns

string

Defined in

src/q/strings-compat.ts:91

trimToNull

▸ trimToNull(s): string

Trims the whitespace characters from the start and end of the string Returns null if the string is null, undefined or whitespace.

Parameters

Name	Type
`s`	`string`

Returns

string

Defined in

src/q/strings-compat.ts:99

trunc

▸ trunc(n): number

Truncates a number to an integer number.

Parameters

Name	Type
`n`	`number`

Returns

number

Defined in

src/base/formatting.ts:282

tryFirst

▸ tryFirst<TItem>(array, predicate): TItem

Gets first element in an array that matches given predicate (similar to LINQ's FirstOrDefault). Returns null if no match is found.

Type parameters

Name
`TItem`

Parameters

Name	Type	Description
`array`	`TItem`[]	Array to test.
`predicate`	(`x`: `TItem`) => `boolean`	Predicate to test elements.

Returns

TItem

First element that matches.

Example

tryFirst([1, 2, 3], x => x == 2); // 2
tryFirst([1, 2, 3], x => x == 4); // null

Defined in

src/q/arrays-compat.ts:204

tryGetText

▸ tryGetText(key): string

Parameters

Name	Type
`key`	`string`

Returns

string

Defined in

src/base/localtext.ts:39

tryGetWidget

▸ tryGetWidget<TWidget>(element, type?): TWidget

Type parameters

Name
`TWidget`

Parameters

Name	Type
`element`	`string` \| `Element` \| `ArrayLike`<`HTMLElement`>
`type?`	(...`args`: `any`[]) => `TWidget`

Returns

TWidget

Defined in

src/ui/widgets/widgetutils.ts:41

turkishLocaleCompare

▸ turkishLocaleCompare(a, b): number

This is an alias for Culture.stringCompare, left in for compatibility reasons.

Parameters

Name	Type
`a`	`string`
`b`	`string`

Returns

number

Defined in

src/q/formatting-compat.ts:25

turkishLocaleToLower

▸ turkishLocaleToLower(a): string

A string to lowercase function that handles special Turkish characters like 'ı'. Left in for compatibility reasons.

Parameters

Name	Type
`a`	`string`

Returns

string

Defined in

src/q/formatting-compat.ts:6

turkishLocaleToUpper

▸ turkishLocaleToUpper(a): string

A string to uppercase function that handles special Turkish characters like 'ı'. Left in for compatibility reasons.

Parameters

Name	Type
`a`	`string`

Returns

string

Defined in

src/q/formatting-compat.ts:16

uiAndBSButtonNoConflict

▸ uiAndBSButtonNoConflict(): void

Returns

void

Defined in

src/base/dialogs.ts:513

useIdPrefix

▸ useIdPrefix(prefix): IdPrefixType

Parameters

Name	Type
`prefix`	`string`

Returns

IdPrefixType

Defined in

src/ui/widgets/widgetutils.ts:110

validateOptions

▸ validateOptions(options?): ValidatorOptions

Parameters

Name	Type
`options?`	`ValidatorOptions`

Returns

ValidatorOptions

Defined in

src/q/validation.ts:11

validatorAbortHandler

▸ validatorAbortHandler(validator): void

Parameters

Name	Type
`validator`	`Validator`

Returns

void

Defined in

src/q/validation.ts:4

warning

▸ warning(message, options?): Partial<Dialog>

Parameters

Name	Type
`message`	`string`
`options?`	`MessageDialogOptions`

Returns

Partial<Dialog>

Deprecated

use warningDialog

Defined in

src/q/dialogs-compat.ts:16

warningDialog

▸ warningDialog(message, options?): Partial<Dialog>

Display a warning dialog

Parameters

Name	Type	Description
`message`	`string`	The message to display
`options?`	`MessageDialogOptions`	Additional options.

Returns

Partial<Dialog>

See

MessageDialogOptions

Example

warningDialog("Something is odd!");

Defined in

src/base/dialogs.ts:926

yesDialogButton

▸ yesDialogButton(opt?): DialogButton

Parameters

Name	Type
`opt?`	`DialogButton`

Returns

DialogButton

Defined in

src/base/dialogs.ts:562

zeroPad

▸ zeroPad(n, len): string

Pads the start of string to make it the specified length.

Parameters

Name	Type	Description
`n`	`number`	The number to pad.
`len`	`number`	Target length of the string.

Returns

string

Defined in

src/q/strings-compat.ts:123

@serenity-is/corelib

Serenity Core Library

Table of contents

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AnyIconClass

Defined in

CancellableViewCallback

Type parameters

Type declaration

Parameters

Returns

Defined in

ClassTypeInfo

Type parameters

Defined in

ComboboxFormatResult

Defined in

ComboboxType

Defined in

Constructor

Type parameters

Type declaration

Parameters

Returns

Defined in

DialogType

Defined in

Dictionary

Type parameters

Index signature

Defined in

EditorProps

Type parameters

Defined in

EditorTypeInfo

Type parameters

Defined in

Format

Type parameters

Type declaration

Parameters

Returns

Defined in

FormatterTypeInfo

Type parameters

Defined in

GroupByElement

Type parameters

Type declaration

Defined in

GroupByResult

Type parameters

Type declaration

Defined in

Grouping

Type parameters

Index signature

Defined in

IconClassName

Defined in

IdPrefixType

Index signature

Type declaration

Defined in

InterfaceTypeInfo

Type parameters

Defined in

KnownIconClass

Defined in

NoInfer

Type parameters

Defined in

NotifyMap