Class ActionRunner

The main class that runs actions

Index

Constructors

Properties

events factory saveToStore

Methods

exec getContext publish run

Constructors

constructor

new ActionRunner(
    events: IEventStoreRead & IEventStoreStreams & IEventSubscriptions & IEventStoreActions & EventModels<
        IEventStore
        | IAsyncEventStore,
    >,
    factory: EventFactory,
    publishMethod?: UpstreamPool,
): ActionRunner
Parameters
- events: IEventStoreRead & IEventStoreStreams & IEventSubscriptions & IEventStoreActions & EventModels<
  IEventStore
  | IAsyncEventStore,
  >
- factory: EventFactory
- OptionalpublishMethod: UpstreamPool
Returns ActionRunner
- Defined in actions/src/action-runner.ts:48

Properties

events

events: IEventStoreRead & IEventStoreStreams & IEventSubscriptions & IEventStoreActions & EventModels<
IEventStore
| IAsyncEventStore,
>

factory

factory: EventFactory

saveToStore

saveToStore: boolean = true

Whether to save all events created by actions to the event store

Methods

exec

exec<Args extends any[]>(
builder: ActionBuilder<Args>,
...args: Args,
): Observable<NostrEvent>
Run an action without publishing the events
Type Parameters
- Args extends any[]
Parameters
- builder: ActionBuilder<Args>
- ...args: Args
Returns Observable<NostrEvent>
- Defined in actions/src/action-runner.ts:106

`Protected`getContext

getContext(): Promise<
    {
        events: IEventStoreRead & IEventStoreStreams & IEventSubscriptions & IEventStoreActions & EventModels<
            IEventStore
            | IAsyncEventStore,
        >;
        factory: EventFactory;
        publish: (
            event: NostrEvent | NostrEvent[],
            relays?: string[],
        ) => Promise<void>;
        run: <Args extends any[]>(
            builder: ActionBuilder<Args>,
            ...args: Args,
        ) => Promise<void>;
        self: string;
        sign: (
            draft: Helpers.EventTemplate | UnsignedEvent,
        ) => Promise<NostrEvent>;
        signer: EventSigner;
        user: User;
    },
>
Returns Promise<
    {
        events: IEventStoreRead & IEventStoreStreams & IEventSubscriptions & IEventStoreActions & EventModels<
            IEventStore
            | IAsyncEventStore,
        >;
        factory: EventFactory;
        publish: (
            event: NostrEvent | NostrEvent[],
            relays?: string[],
        ) => Promise<void>;
        run: <Args extends any[]>(
            builder: ActionBuilder<Args>,
            ...args: Args,
        ) => Promise<void>;
        self: string;
        sign: (
            draft: Helpers.EventTemplate | UnsignedEvent,
        ) => Promise<NostrEvent>;
        signer: EventSigner;
        user: User;
    },
>
- Defined in actions/src/action-runner.ts:54

publish

publish(event: NostrEvent | NostrEvent[], relays?: string[]): Promise<void>
Internal method for publishing events to relays
Parameters
- event: NostrEvent | NostrEvent[]
- Optionalrelays: string[]
Returns Promise<void>
- Defined in actions/src/action-runner.ts:71

run

run<Args extends any[]>(
builder: ActionBuilder<Args>,
...args: Args,
): Promise<void>
Run an action and publish events using the publish method
Type Parameters
- Args extends any[]
Parameters
- builder: ActionBuilder<Args>
- ...args: Args
Returns Promise<void>
- Defined in actions/src/action-runner.ts:99