@dxos/compute - v0.16.0
    Preparing search index...

    Interface InvokeOptions

    interface InvokeOptions {
        event:
            | {
                body: string;
                created: string;
                from: string;
                subject: string;
                to: string;
            }
            | {
                cursor: string;
                feed: Ref<Feed & OfKind<Object> & Unknown>;
                item: any;
                items?: readonly any[];
            }
            | {
                changedObjectId?: string;
                subject: Ref<Unknown>;
                type: "updated" | "created" | "deleted";
            }
            | { tick: number }
            | { data?: { readonly [key: string]: any } }
            | {
                bodyText: string;
                headers: { readonly [key: string]: string };
                method: "GET" | "POST";
                url: string;
            };
        trigger: Trigger.Trigger;
    }
    Index

    Properties

    Properties

    event:
        | {
            body: string;
            created: string;
            from: string;
            subject: string;
            to: string;
        }
        | {
            cursor: string;
            feed: Ref<Feed & OfKind<Object> & Unknown>;
            item: any;
            items?: readonly any[];
        }
        | {
            changedObjectId?: string;
            subject: Ref<Unknown>;
            type: "updated" | "created" | "deleted";
        }
        | { tick: number }
        | { data?: { readonly [key: string]: any } }
        | {
            bodyText: string;
            headers: { readonly [key: string]: string };
            method: "GET" | "POST";
            url: string;
        }

    Type declaration

    • { body: string; created: string; from: string; subject: string; to: string }
    • {
          cursor: string;
          feed: Ref<Feed & OfKind<Object> & Unknown>;
          item: any;
          items?: readonly any[];
      }
      • Readonlycursor: string

        Cursor of the batch's last item.

      • Readonlyfeed: Ref<Feed & OfKind<Object> & Unknown>
      • Readonlyitem: any

        The first item of the batch (the only one unless the trigger sets batchSize).

      • Optional Readonlyitems?: readonly any[]

        The batch, in feed order; [item] unless the trigger sets batchSize.

    • {
          changedObjectId?: string;
          subject: Ref<Unknown>;
          type: "updated" | "created" | "deleted";
      }
      • Optional ReadonlychangedObjectId?: string

        Use subject.

      • Readonlysubject: Ref<Unknown>

        Reference to the object that was changed or created. For deleted, carries the object's URI; dereferencing may yield undefined since the object is gone.

      • Readonlytype: "updated" | "created" | "deleted"

        Type of the mutation.

    • { tick: number }
    • { data?: { readonly [key: string]: any } }
    • {
          bodyText: string;
          headers: { readonly [key: string]: string };
          method: "GET" | "POST";
          url: string;
      }
    trigger: Trigger.Trigger