Index

src/querying/metadata.ts

BlueriqChild
BlueriqChild(type, selector, options?)
Parameters :
Name Optional
type No
selector No
options Yes
BlueriqChild
BlueriqChild(type, options?)

Property decorator for letting a component automatically query an element with specified characteristics. The result is kept in sync with the page model as element updates arrive.

Parameters :
Name Optional
type No
options Yes
BlueriqChild
BlueriqChild(type, selector?, options)
Parameters :
Name Optional
type No
selector Yes
options No
BlueriqChildren
BlueriqChildren(type, selector?, options)
Parameters :
Name Optional
type No
selector Yes
options No
BlueriqChildren
BlueriqChildren(type, options?)

Property decorator for letting a component automatically query for elements with specified characteristics. The result is kept in sync with the page model as element updates arrive.

Parameters :
Name Optional
type No
options Yes
BlueriqChildren
BlueriqChildren(type, selector, options?)
Parameters :
Name Optional
type No
selector No
options Yes

src/component/metadata.ts

BlueriqComponent
BlueriqComponent(component)

Decorator function to go along the Angular ComponentDecorator to specify the details of a Blueriq component.

Parameters :
Name Optional
component No

src/component/selector.ts

bySelector
bySelector(selector, options?)

Creates a component matcher from a CSS-like selector. Optionally allows for specifying a priority offset when the priority as computed from the selector is desired to be changed.

For scoped components that are registered with BlueriqComponents.scoped, it is advised to use this function as it ensures the selector is only compiled once. Furthermore, any errors that may occur from the compilation of the selector become apparent during startup, instead of during the first time the component is in scope.

Any errors that occur during the compilation of the selector will not be handled gracefully as would be the case when a raw string selector would have been used.

Parameters :
Name Optional
selector No
options Yes

src/rxjs/cleanup.ts

cleanup
cleanup(cleanupFn)
Parameters :
Name Optional
cleanupFn No

src/component/types.ts

getAngularComponent
getAngularComponent(element)

Given a Blueriq element, returns the Angular ComponentRef that was rendered for the element. This may be undefined, in the case where the element has not been rendered using BqElementDirective.

Parameters :
Name Optional Description
element No

The Blueriq element to obtain the ComponentRef for.

forms/src/control.ts

getBlueriqField
getBlueriqField(control)
Parameters :
Name Optional
control No

forms/src/validator.ts

getFieldMessages
getFieldMessages(control)

Returns a set of field messages as currently registered on the form control. This is different from using Blueriq's Field.messages in the sense that a form control's messages may include frontend validation results as the user is currently typing in the form control.

Parameters :
Name Optional
control No

src/api/error.ts

isBlueriqError
isBlueriqError(error: any, errorType?)

Determines if the error is recognized as BlueriqResponseError, optionally requiring a specific type of error. If an error is not recognized as such, it may be because of several reasons such as the following:

  1. No internet connection or network related glitches
  2. Incorrect backend/proxy configuration, resulting in endpoints not being found.
Parameters :
Name Type Optional Description
error any No

Some error to potentially recognize as Blueriq error.

errorType Yes

Optionally require error to be of a specific type.

src/session/startup/module.ts

provideLocalStorage
provideLocalStorage()
provideSessionStorage
provideSessionStorage()

result-matching ""

    No results matching ""