Class Trigger

Function trigger. Runnable is invoked with the payload passed as input data. The event that fires the trigger is available in the runnable context.

Hierarchy

{
    concurrency?: number;
    enabled?: boolean;
    input?: { readonly [key: string]: any };
    inputNodeId?: string;
    remote?: boolean;
    runnable?: Ref<PersistentOperation & OfKind<Object> & Unknown>;
    spec?:
        | { kind: "email" }
        | {
            batchSize?: number;
            feed?: Ref<Feed & OfKind<Object> & Unknown>;
            kind: "feed";
        }
        | {
            kind: "subscription";
            options?: { deep?: boolean; delay?: number };
            query: {
                ast:
                    | QuerySelectClause
                    | QueryFilterClause
                    | QueryReferenceTraversalClause
                    | QueryIncomingReferencesClause
                    | QueryRelationClause
                    | QueryRelationTraversalClause
                    | QueryHierarchyTraversalClause
                    | QueryUnionClause
                    | QuerySetDifferenceClause
                    | QueryOrderClause
                    | QueryOptionsClause
                    | QueryLimitClause
                    | QuerySkipClause
                    | QueryAggregateClause
                    | QueryFromClause;
                raw?: string;
            };
        }
        | { kind: "direct" }
        | { cron: string; kind: "timer" }
        | { kind: "webhook"; method?: string; port?: number };
} & OfKind<Object, this>
- Trigger

Index

Constructors

constructor

Properties

~@dxos/echo/Kind concurrency? enabled? id input? inputNodeId? remote? runnable? spec? ~@dxos/echo/Kind ~@dxos/echo/SchemaKind ~@dxos/echo/Type.Instance? ~@dxos/echo/Type.StaticSchema fields id jsonSchema name?

Constructors

constructor

new Trigger(_: never): Trigger.Trigger
Parameters
- _: never
Returns Trigger.Trigger
Inherited from Type.makeObject<Trigger>(DXN.make('org.dxos.type.trigger', '0.1.0'))( Schema.Struct({ /** * Runnable (operation or workflow) to invoke. * Wired programmatically (see plugin-routine's `wireTriggers`); not user-editable, so hidden from forms. */ runnable: Ref.Ref(Runnable.Runnable).pipe( Schema.annotate({ title: 'Runnable' }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), spec: Spec.pipe(Schema.optional), enabled: Schema.Boolean.pipe(Schema.optional), /** * Runs this trigger on the edge rather than locally. * When unset, the trigger runs locally on the client. */ remote: Schema.Boolean.pipe(Schema.annotate({ title: 'Remote' }), Schema.optional), concurrency: Schema.Number.pipe( Schema.annotate({ title: 'Concurrency', default: 1, description: 'Maximum number of concurrent invocations of the trigger.', }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), /** * Only used for workflowSchema. * Specifies the input node in the circuit. * @deprecated Remove and enforce a single input node in all compute graphSchema. */ inputNodeId: Schema.String.pipe( Schema.annotate({ title: 'Input Node ID' }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), /** * Passed as the input data to the runnable. */ input: InputTemplate.pipe(Annotation.FormInputAnnotation.set(false), Schema.optional), }).pipe(Annotation.IconAnnotation.set({ icon: 'ph--lightning--regular', hue: 'yellow' })), ).constructor
- Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:72

Properties

`Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Object

Inherited from Type.makeObject<Trigger>(DXN.make('org.dxos.type.trigger', '0.1.0'))( Schema.Struct({ /** * Runnable (operation or workflow) to invoke. * Wired programmatically (see plugin-routine's `wireTriggers`); not user-editable, so hidden from forms. */ runnable: Ref.Ref(Runnable.Runnable).pipe( Schema.annotate({ title: 'Runnable' }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), spec: Spec.pipe(Schema.optional), enabled: Schema.Boolean.pipe(Schema.optional), /** * Runs this trigger on the edge rather than locally. * When unset, the trigger runs locally on the client. */ remote: Schema.Boolean.pipe(Schema.annotate({ title: 'Remote' }), Schema.optional), concurrency: Schema.Number.pipe( Schema.annotate({ title: 'Concurrency', default: 1, description: 'Maximum number of concurrent invocations of the trigger.', }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), /** * Only used for workflowSchema. * Specifies the input node in the circuit. * @deprecated Remove and enforce a single input node in all compute graphSchema. */ inputNodeId: Schema.String.pipe( Schema.annotate({ title: 'Input Node ID' }), Annotation.FormInputAnnotation.set(false), Schema.optional, ), /** * Passed as the input data to the runnable. */ input: InputTemplate.pipe(Annotation.FormInputAnnotation.set(false), Schema.optional), }).pipe(Annotation.IconAnnotation.set({ icon: 'ph--lightning--regular', hue: 'yellow' })), ).~@dxos/echo/Kind

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:20

`Optional` `Readonly`concurrency

concurrency?: number = ...

Defined in packages/core/compute/compute/src/types/Trigger.ts:226

`Optional` `Readonly`enabled

enabled?: boolean = ...

Defined in packages/core/compute/compute/src/types/Trigger.ts:218

`Readonly`id

id: string

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:21

`Optional` `Readonly`input

input?: { readonly [key: string]: any } = ...

Passed as the input data to the runnable.

Defined in packages/core/compute/compute/src/types/Trigger.ts:250

`Optional` `Readonly`inputNodeId

inputNodeId?: string = ...

Only used for workflowSchema. Specifies the input node in the circuit.

Deprecated

Remove and enforce a single input node in all compute graphSchema.

Defined in packages/core/compute/compute/src/types/Trigger.ts:241

`Optional` `Readonly`remote

remote?: boolean = ...

Runs this trigger on the edge rather than locally. When unset, the trigger runs locally on the client.

Defined in packages/core/compute/compute/src/types/Trigger.ts:224

`Optional` `Readonly`runnable

runnable?: Ref<PersistentOperation & OfKind<Object> & Unknown> = ...

Runnable (operation or workflow) to invoke. Wired programmatically (see plugin-routine's wireTriggers); not user-editable, so hidden from forms.

Defined in packages/core/compute/compute/src/types/Trigger.ts:210

`Optional` `Readonly`spec

spec?:
    | { kind: "email" }
    | {
        batchSize?: number;
        feed?: Ref<Feed & OfKind<Object> & Unknown>;
        kind: "feed";
    }
    | {
        kind: "subscription";
        options?: { deep?: boolean; delay?: number };
        query: {
            ast:
                | QuerySelectClause
                | QueryFilterClause
                | QueryReferenceTraversalClause
                | QueryIncomingReferencesClause
                | QueryRelationClause
                | QueryRelationTraversalClause
                | QueryHierarchyTraversalClause
                | QueryUnionClause
                | QuerySetDifferenceClause
                | QueryOrderClause
                | QueryOptionsClause
                | QueryLimitClause
                | QuerySkipClause
                | QueryAggregateClause
                | QueryFromClause;
            raw?: string;
        };
    }
    | { kind: "direct" }
    | { cron: string; kind: "timer" }
    | { kind: "webhook"; method?: string; port?: number } = ...

Type declaration

{ kind: "email" }
{
    batchSize?: number;
    feed?: Ref<Feed & OfKind<Object> & Unknown>;
    kind: "feed";
}
- Optional ReadonlybatchSize?: number
  Consecutive feed items delivered per invocation, as event.items in feed order; one when unset. The last batch of a read is short rather than waiting for the feed to fill it.
- Optional Readonlyfeed?: Ref<Feed & OfKind<Object> & Unknown>
- Readonlykind: "feed"
{
    kind: "subscription";
    options?: { deep?: boolean; delay?: number };
    query: {
        ast:
            | QuerySelectClause
            | QueryFilterClause
            | QueryReferenceTraversalClause
            | QueryIncomingReferencesClause
            | QueryRelationClause
            | QueryRelationTraversalClause
            | QueryHierarchyTraversalClause
            | QueryUnionClause
            | QuerySetDifferenceClause
            | QueryOrderClause
            | QueryOptionsClause
            | QueryLimitClause
            | QuerySkipClause
            | QueryAggregateClause
            | QueryFromClause;
        raw?: string;
    };
}
{ kind: "direct" }
{ cron: string; kind: "timer" }
{ kind: "webhook"; method?: string; port?: number }

Defined in packages/core/compute/compute/src/types/Trigger.ts:216

`Static` `Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Type

Entity-kind brand of the type-entity value itself — always EntityKind.Type. The kind of instance the type describes lives on [SchemaKindId] (Object / Relation / Type). Lets Obj.isObject / Relation.isRelation reject type entities by a single [KindId] check.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:23

`Static` `Readonly`~@dxos/echo/SchemaKind

"~@dxos/echo/SchemaKind": Object

Schema-kind brand (object).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:57

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

"~@dxos/echo/Type.Instance"?: Trigger.Trigger & OfKind<Object>

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:34

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

"~@dxos/echo/Type.StaticSchema": Codec<any, any>

Source Effect Schema — used internally by Type.getSchema(self).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:59

`Static` `Readonly`fields

fields: {}

The fields defined in the original struct schema. Allows accessing field definitions for introspection.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:64

`Static` `Readonly`id

id: string

Object id. Like all ECHO entities, type entities always carry an id — stamped at construction for in-memory (static) declarations and assigned by the database once persisted. The id does NOT determine the entity's URI: static types resolve to their typename DXN, persisted types to echo:///<id> (see getTypeURIFromSpecifier).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:31

`Static` `Readonly`jsonSchema

jsonSchema: JsonSchemaType

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:33

`Static` `Optional` `Readonly`name

name?: string

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:32

Class Trigger

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Trigger.Trigger

Properties

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`concurrency

`Optional` `Readonly`enabled

`Readonly`id

`Optional` `Readonly`input

`Optional` `Readonly`inputNodeId

Deprecated

`Optional` `Readonly`remote

`Optional` `Readonly`runnable

`Optional` `Readonly`spec

Type declaration

`Optional` `Readonly`batchSize?: number

`Optional` `Readonly`feed?: Ref<Feed & OfKind<Object> & Unknown>

`Readonly`kind: "feed"

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name

Settings

On This Page

Class Trigger

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Trigger.Trigger

Properties

Readonly~@dxos/echo/Kind

Optional Readonlyconcurrency

Optional Readonlyenabled

Readonlyid

Optional Readonlyinput

Optional ReadonlyinputNodeId

Deprecated

Optional Readonlyremote

Optional Readonlyrunnable

Optional Readonlyspec

Type declaration

Optional ReadonlybatchSize?: number

Optional Readonlyfeed?: Ref<Feed & OfKind<Object> & Unknown>

Readonlykind: "feed"

Static Readonly~@dxos/echo/Kind

Static Readonly~@dxos/echo/SchemaKind

Static Optional Readonly~@dxos/echo/Type.Instance

Static Readonly~@dxos/echo/Type.StaticSchema

Static Readonlyfields

Static Readonlyid

Static ReadonlyjsonSchema

Static Optional Readonlyname

Settings

On This Page

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`concurrency

`Optional` `Readonly`enabled

`Readonly`id

`Optional` `Readonly`input

`Optional` `Readonly`inputNodeId

`Optional` `Readonly`remote

`Optional` `Readonly`runnable

`Optional` `Readonly`spec

`Optional` `Readonly`batchSize?: number

`Optional` `Readonly`feed?: Ref<Feed & OfKind<Object> & Unknown>

`Readonly`kind: "feed"

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name