Class EventFactory

constructor

• new EventFactory(context?): EventFactory

• Parameters

  • context: EventFactoryContext = {}

  Returns EventFactory

context

comment

• comment(...args): Promise<EventTemplate>

• Create a NIP-22 comment

  Parameters

  • Rest...args: [parent: Event, content: string, options?: TextContentOptions]

  Returns Promise<EventTemplate>

create

• create<Args>(blueprint, ...args): Promise<EventTemplate>

• Create an event from a blueprint

  Type Parameters

  • Args extends any[]

  Parameters

  • blueprint: ((...args: Args) => EventBlueprint)
    • • (...args): EventBlueprint

      • Parameters

        • Rest...args: Args

        Returns EventBlueprint

  • Rest...args: Args

  Returns Promise<EventTemplate>

delete

• delete(...args): Promise<EventTemplate>

• Creates a delete event

  Parameters

  • Rest...args: [events: Event[], reason?: string]

  Returns Promise<EventTemplate>

modify

• modify(draft, ...operations): Promise<EventTemplate>

• Modify an existing event with operations and updated the created_at

  Parameters

  • draft: Event | EventFactoryTemplate
  • Rest...operations: (undefined | EventOperation)[]

  Returns Promise<EventTemplate>

modifyTags

• modifyTags(event, tagOperations?, eventOperations?): Promise<EventTemplate>

• Modify a lists public and hidden tags and updated the created_at

  Parameters

  • event: EventFactoryTemplate
  • OptionaltagOperations: TagOperation | TagOperation[] | {
        hidden?: TagOperation | TagOperation[];
        public?: TagOperation | TagOperation[];
    }
  • OptionaleventOperations: EventOperation | (undefined | EventOperation)[]

  Returns Promise<EventTemplate>

note

• note(...args): Promise<EventTemplate>

• Creates a short text note

  Parameters

  • Rest...args: [content: string, options?: NoteBlueprintOptions]

  Returns Promise<EventTemplate>

noteReply

• noteReply(...args): Promise<EventTemplate>

• Creates a short text note reply

  Parameters

  • Rest...args: [parent: Event, content: string, options?: TextContentOptions]

  Returns Promise<EventTemplate>

process

• process(template, ...operations): Promise<EventTemplate>

• Process an event template with operations

  Parameters

  • template: EventFactoryTemplate
  • Rest...operations: (undefined | EventOperation)[]

  Returns Promise<EventTemplate>

reaction

• reaction(...args): Promise<EventTemplate>

• Creates a reaction event

  Parameters

  • Rest...args: [event: Event, emoji: string | Helpers.Emoji]

  Returns Promise<EventTemplate>

share

• share(...args): Promise<EventTemplate>

• Creates a share event

  Parameters

  • Rest...args: [event: Event]

  Returns Promise<EventTemplate>

stamp

• stamp(draft): Promise<UnsignedEvent>

• Attaches the signers pubkey to an event template

  Parameters

  • draft: EventTemplate

  Returns Promise<UnsignedEvent>

StaticrunProcess

• runProcess(template, context, ...operations): Promise<EventTemplate>

• Parameters

  • template: EventFactoryTemplate
  • context: EventFactoryContext
  • Rest...operations: (undefined | EventOperation)[]

  Returns Promise<EventTemplate>