Class PersistentOperation

Database record of an operation. The registry key and version live in the object meta — access via Obj.getMeta(record).key and Obj.getMeta(record).version.

Hierarchy

{
    binding?: string;
    description?: string;
    icon?: string;
    inputSchema?: JsonSchemaType;
    name: string;
    outputSchema?: JsonSchemaType;
    services?: readonly string[];
    source?: Ref<Unknown>;
    updated?: string;
} & OfKind<Object, this>
- PersistentOperation

Constructors

constructor

new PersistentOperation(_: never): PersistentOperation
Parameters
- _: never
Returns PersistentOperation
Inherited from Type.makeObject<PersistentOperation>( DXN.make('org.dxos.type.function', '0.2.0'), )( Schema$.Struct({ name: Schema$.NonEmptyString, description: Schema$.optional(Schema$.String), /** * ISO date string of the last deployment. */ updated: Schema$.optional(Schema$.String), // Reference to a source script if it exists within ECHO. // TODO(burdon): Don't ref ScriptType directly (core). source: Schema$.optional(Ref.Ref(Obj.Unknown)), inputSchema: Schema$.optional(JsonSchema.JsonSchema), outputSchema: Schema$.optional(JsonSchema.JsonSchema), /** * List of required services. * Match the Context.Tag keys of the services the operation handler declares. */ services: Schema$.optional(Schema$.Array(Schema$.String)), // Local binding to a function name. // TODO(dmaretskyi): Add this field to Operation.Definition. binding: Schema$.optional(Schema$.String), /** * Phosphor icon identifier in `ph--<name>--<variant>` format (e.g. `ph--file-text--regular`). */ icon: Schema$.optional(Schema$.String), }).pipe( Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--function--regular', hue: 'blue' }), ), ).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<PersistentOperation>( DXN.make('org.dxos.type.function', '0.2.0'), )( Schema$.Struct({ name: Schema$.NonEmptyString, description: Schema$.optional(Schema$.String), /** * ISO date string of the last deployment. */ updated: Schema$.optional(Schema$.String), // Reference to a source script if it exists within ECHO. // TODO(burdon): Don't ref ScriptType directly (core). source: Schema$.optional(Ref.Ref(Obj.Unknown)), inputSchema: Schema$.optional(JsonSchema.JsonSchema), outputSchema: Schema$.optional(JsonSchema.JsonSchema), /** * List of required services. * Match the Context.Tag keys of the services the operation handler declares. */ services: Schema$.optional(Schema$.Array(Schema$.String)), // Local binding to a function name. // TODO(dmaretskyi): Add this field to Operation.Definition. binding: Schema$.optional(Schema$.String), /** * Phosphor icon identifier in `ph--<name>--<variant>` format (e.g. `ph--file-text--regular`). */ icon: Schema$.optional(Schema$.String), }).pipe( Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--function--regular', hue: 'blue' }), ), ).~@dxos/echo/Kind

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

`Optional` `Readonly`binding

binding?: string = ...

Defined in packages/core/compute/compute/src/Operation.ts:830

`Optional` `Readonly`description

description?: string = ...

Defined in packages/core/compute/compute/src/Operation.ts:808

`Optional` `Readonly`icon

icon?: string = ...

Phosphor icon identifier in ph--<name>--<variant> format (e.g. ph--file-text--regular).

Defined in packages/core/compute/compute/src/Operation.ts:835

`Readonly`id

id: string

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

`Optional` `Readonly`inputSchema

inputSchema?: JsonSchemaType = ...

Defined in packages/core/compute/compute/src/Operation.ts:819

`Readonly`name

name: string = Schema$.NonEmptyString

Defined in packages/core/compute/compute/src/Operation.ts:806

`Optional` `Readonly`outputSchema

outputSchema?: JsonSchemaType = ...

Defined in packages/core/compute/compute/src/Operation.ts:820

`Optional` `Readonly`services

services?: readonly string[] = ...

List of required services. Match the Context.Tag keys of the services the operation handler declares.

Defined in packages/core/compute/compute/src/Operation.ts:826

`Optional` `Readonly`source

source?: Ref<Unknown> = ...

Defined in packages/core/compute/compute/src/Operation.ts:817

`Optional` `Readonly`updated

updated?: string = ...

ISO date string of the last deployment.

Defined in packages/core/compute/compute/src/Operation.ts:813

`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"?: PersistentOperation & 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 PersistentOperation

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns PersistentOperation

Properties

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`binding

`Optional` `Readonly`description

`Optional` `Readonly`icon

`Readonly`id

`Optional` `Readonly`inputSchema

`Readonly`name

`Optional` `Readonly`outputSchema

`Optional` `Readonly`services

`Optional` `Readonly`source

`Optional` `Readonly`updated

`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 PersistentOperation

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns PersistentOperation

Properties

Readonly~@dxos/echo/Kind

Optional Readonlybinding

Optional Readonlydescription

Optional Readonlyicon

Readonlyid

Optional ReadonlyinputSchema

Readonlyname

Optional ReadonlyoutputSchema

Optional Readonlyservices

Optional Readonlysource

Optional Readonlyupdated

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`binding

`Optional` `Readonly`description

`Optional` `Readonly`icon

`Readonly`id

`Optional` `Readonly`inputSchema

`Readonly`name

`Optional` `Readonly`outputSchema

`Optional` `Readonly`services

`Optional` `Readonly`source

`Optional` `Readonly`updated

`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