ReadAppInstance
Defined in: runtime/app.ts:67
Extends
Section titled “Extends”BaseAppInstance
Properties
Section titled “Properties”metrics
Section titled “metrics”
readonlymetrics:Record<string,MetricInstance>
Defined in: runtime/app.ts:47
Inherited from
Section titled “Inherited from”BaseAppInstance.metrics
readonlyprn:string
Defined in: runtime/app.ts:45
Inherited from
Section titled “Inherited from”BaseAppInstance.prn
queries
Section titled “queries”
readonlyqueries:Record<string,QueryHandlerInstance>
Defined in: runtime/app.ts:46
Inherited from
Section titled “Inherited from”BaseAppInstance.queries
readonlyroles:Record<string,ReadAppRoleInstance>
Defined in: runtime/app.ts:68
searches
Section titled “searches”
readonlysearches:Record<string,ReadSearchIndexInstance>
Defined in: runtime/app.ts:69
templates
Section titled “templates”
readonlytemplates:Record<string,ReadTemplate>
Defined in: runtime/app.ts:70
unions
Section titled “unions”
readonlyunions:Record<string,ReadUnionInstance>
Defined in: runtime/app.ts:71
workspaceId
Section titled “workspaceId”
readonlyworkspaceId:string
Defined in: runtime/index.ts:39
Inherited from
Section titled “Inherited from”BaseAppInstance.workspaceId
Methods
Section titled “Methods”assertRole()
Section titled “assertRole()”assertRole(
role):true
Defined in: runtime/app.ts:53
Asserts that the current, active instance has the current role. If successful, this will return true. Otherwise it will throw an Error.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”true
Inherited from
Section titled “Inherited from”BaseAppInstance.assertRole
checkRole()
Section titled “checkRole()”checkRole(
role):boolean
Defined in: runtime/app.ts:59
Checks that the current, active instance has the current role; returning true/false if that role is present.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”BaseAppInstance.checkRole
report()
Section titled “report()”report(
request):Promise<Readonly<{report:MetricReportEntry; }>>
Defined in: runtime/app.ts:64
Executes a metric report.
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<Readonly<{ report: MetricReportEntry; }>>
Inherited from
Section titled “Inherited from”BaseAppInstance.report