Documentation / queries/ObservableQueryFor
queries/ObservableQueryFor
Classes
abstract
ObservableQueryFor<TDataType, TArguments>
Represents an implementation of IQueryFor.
Type Parameters
• TDataType
Type of data returned by the query.
• TArguments = object
Implements
IObservableQueryFor
<TDataType
,TArguments
>
Constructors
new ObservableQueryFor()
new ObservableQueryFor<
TDataType
,TArguments
>(modelType
,enumerable
):ObservableQueryFor
<TDataType
,TArguments
>
Initializes a new instance of the <,>} class.
Parameters
modelType
Constructor
Type of model, if an enumerable, this is the instance type.
enumerable
boolean
Whether or not it is an enumerable.
Returns
ObservableQueryFor
<TDataType
, TArguments
>
Defined in
queries/ObservableQueryFor.ts:43
Properties
defaultValue
abstract
readonly
defaultValue:TDataType
Implementation of
IObservableQueryFor
.defaultValue
Defined in
queries/ObservableQueryFor.ts:33
enumerable
readonly
enumerable:boolean
Whether or not it is an enumerable.
Defined in
queries/ObservableQueryFor.ts:43
modelType
readonly
modelType:Constructor
Type of model, if an enumerable, this is the instance type.
Defined in
queries/ObservableQueryFor.ts:43
paging
paging:
Paging
Gets the paging for the query.
Implementation of
Defined in
queries/ObservableQueryFor.ts:36
route
abstract
readonly
route:string
Implementation of
Defined in
queries/ObservableQueryFor.ts:31
routeTemplate
abstract
readonly
routeTemplate:TemplateDelegate
<any
>
Implementation of
IObservableQueryFor
.routeTemplate
Defined in
queries/ObservableQueryFor.ts:32
sorting
sorting:
Sorting
Gets the sorting for the query.
Implementation of
Defined in
queries/ObservableQueryFor.ts:35
Accessors
requiredRequestArguments
Get Signature
get
abstract
requiredRequestArguments():string
[]
Returns
string
[]
Implementation of
IObservableQueryFor
.requiredRequestArguments
Defined in
queries/ObservableQueryFor.ts:34
Methods
dispose()
dispose():
void
Disposes the query.
Returns
void
Defined in
queries/ObservableQueryFor.ts:53
setApiBasePath()
setApiBasePath(
apiBasePath
):void
Set the base path for the API to use for the query. This is used to prepend to the path to any fetch operation.
Parameters
apiBasePath
string
Base path for the API
Returns
void
Implementation of
IObservableQueryFor
.setApiBasePath
Defined in
queries/ObservableQueryFor.ts:63
setMicroservice()
setMicroservice(
microservice
):void
Set the microservice to be used for the query. This is passed along to the server to identify the microservice.
Parameters
microservice
string
Name of microservice
Returns
void
Implementation of
IObservableQueryFor
.setMicroservice
Defined in
queries/ObservableQueryFor.ts:58
subscribe()
subscribe(
callback
,args
?):ObservableQuerySubscription
<TDataType
>
Subscribe to the query. This will create a subscription onto the server.
Parameters
callback
OnNextResult
<QueryResult
<TDataType
>>
The callback that will receive result from the server.
args?
TArguments
Optional arguments for the query - depends on whether or not the query needs arguments.
Returns
ObservableQuerySubscription
<TDataType
>
.