AppBuilder

Defined in: builder/app.ts:130

This is the AppBuilder you will see when importing an app as a Dependency. It is the base of the broader “AppBuilder” below and this is a subset of the AppBuilder. It has all the interesting entities, but not operations like addDependency ans so forth.

Extends

BaseBuilder.DependencyAppBuilder

Type Parameters

TTypes

TTypes extends AppBuilderTypes = AppBuilderTypes

Properties

dependencies

readonly dependencies: Record<string, DependencyAppBuilder<any>>

Defined in: builder/app.ts:131

events

readonly events: Record<string, EventBuilder>

Defined in: builder/app.ts:117

Inherited from

DependencyAppBuilder.events

hooks

readonly hooks: AppHookDefinition

Defined in: builder/app.ts:132

key

readonly key: string

Defined in: builder/app.ts:118

Inherited from

DependencyAppBuilder.key

mutations

readonly mutations: Record<string, MutationBuilder>

Defined in: builder/app.ts:133

prn

readonly prn: string

Defined in: builder/index.ts:32

Inherited from

BaseBuilder.prn

queries

readonly queries: Record<string, QueryBuilder>

Defined in: builder/app.ts:134

roles

readonly roles: Record<string, AppRoleBuilder>

Defined in: builder/app.ts:135

Overrides

DependencyAppBuilder.roles

searches

readonly searches: Record<string, SearchIndexBuilder>

Defined in: builder/app.ts:136

Overrides

DependencyAppBuilder.searches

templates

readonly templates: Record<string, TemplateBuilder>

Defined in: builder/app.ts:122

Inherited from

DependencyAppBuilder.templates

unions

readonly unions: Record<string, UnionBuilder>

Defined in: builder/app.ts:123

Inherited from

DependencyAppBuilder.unions

Methods

addDependency()

addDependency<TKey>(key, spec): DependencyAppBuilder<any>

Defined in: builder/app.ts:148

Adds the app as a dependency of this app. When in runtime, the dependency will appear under the context (ctx) with the given key. If the same dependency is added in multiple places (apps), it is the same dependency. That is, there only ever one “employeeProfile” in a runtime definition and instance.

The key is “local” to this app. The dependent app sets it’s own canonical id/key.

Type Parameters

TKey

TKey extends string

Parameters

key

TKey

spec

AppSpec | ((builder) => void)

Returns

DependencyAppBuilder<any>

addEvent()

addEvent(key): EventBuilder

Defined in: builder/app.ts:154

Adds an event that can be published against items of this template type. Events on the app level are always published against the workspace item.

Parameters

key

string

Returns

EventBuilder

addMetric()

addMetric(key): MetricBuilder

Defined in: builder/app.ts:171

Adds a new metric to this app. A metric is a time-series based aggregation of the supplied events. In the runtime, metrics can be queried by an interval using the configured dimensions.

Parameters

key

string

Returns

MetricBuilder

See

MetricBuilder

addMetricDimension()

addMetricDimension(key, subject): MetricDimensionBuilder

Defined in: builder/app.ts:162

Adds a new dimension to this app. A dimension is an aspect by which metrics can be broken down, filtered, and further categorized. Concrete dimensions are an item (instance) in the app of the template type specified here.

Parameters

key

string

subject

(TemplateBuilder | UnionBuilder)[]

Returns

MetricDimensionBuilder

addMutation()

Call Signature

addMutation<TKey>(key, handler): MutationBuilder

Defined in: builder/app.ts:173

Type Parameters

TKey

TKey extends string

Parameters

key

TKey

handler

MutationHandler<ExtractMutationInput<TKey, TTypes>, ExtractMutationOutput<TKey, TTypes>, TTypes["WriteAppInstance"], TTypes["WriteRuntimeInstance"]>

Returns

MutationBuilder

Call Signature

addMutation<TKey>(key, options, handler): MutationBuilder

Defined in: builder/app.ts:182

Type Parameters

TKey

TKey extends string

Parameters

key

TKey

options

MutationOptions

handler

MutationHandler<ExtractMutationInput<TKey, TTypes>, ExtractMutationOutput<TKey, TTypes>, TTypes["WriteAppInstance"], TTypes["WriteRuntimeInstance"]>

Returns

MutationBuilder

addQuery()

Call Signature

addQuery<TKey>(key, handler): QueryBuilder

Defined in: builder/app.ts:193

Type Parameters

TKey

TKey extends string

Parameters

key

TKey

handler

QueryHandler<ExtractQueryInput<TKey, TTypes>, ExtractQueryOutput<TKey, TTypes>, TTypes["ReadAppInstance"], TTypes["ReadRuntimeInstance"]>

Returns

QueryBuilder

Call Signature

addQuery<TKey>(key, options, handler): QueryBuilder

Defined in: builder/app.ts:202

Type Parameters

TKey

TKey extends string

Parameters

key

TKey

options

QueryOptions

handler

QueryHandler<ExtractQueryInput<TKey, TTypes>, ExtractQueryOutput<TKey, TTypes>, TTypes["ReadAppInstance"], TTypes["ReadRuntimeInstance"]>

Returns

QueryBuilder

addRole()

addRole(key, options): AppRoleBuilder

Defined in: builder/app.ts:221

Adds an application-level role that can be owned by a principal. App Roles are broad-based roles such as “Owner” for the whole application. For fine-grained permissions see: