Class EventFactory

constructor

• new EventFactory(context?: EventFactoryContext): EventFactory

  Parameters

  • context: EventFactoryContext = {}

  Returns EventFactory

context

build

• build(
      template: EventFactoryTemplate,
      ...operations: (undefined | EventOperation)[],
  ): Promise<Helpers.EventTemplate>

  Build an event template with operations

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

comment

• comment(
      ...args: [
          parent: Event,
          content: string,
          options?: CommentBlueprintOptions,
      ],
  ): Promise<Helpers.EventTemplate>

  Create a NIP-22 comment

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

create

• create<
      Args extends any[],
      T extends Event | Helpers.EventTemplate | UnsignedEvent,
  >(
      blueprintConstructor: (...args: Args) => EventBlueprint<T>,
      ...args: Args,
  ): Promise<T>

  Create an event from a blueprint

  Type Parameters

  • Args extends any[]
  • T extends Event | Helpers.EventTemplate | UnsignedEvent

  Parameters

  • blueprintConstructor: (...args: Args) => EventBlueprint<T>
  • ...args: Args

  Returns Promise<T>

delete

• delete(
      ...args: [events: Event[], reason?: string],
  ): Promise<Helpers.EventTemplate>

  Creates a delete event

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

modify

• modify(
      draft: Event | Helpers.EventTemplate | UnsignedEvent,
      ...operations: (undefined | EventOperation)[],
  ): Promise<Helpers.EventTemplate>

  Modify an existing event with operations and updated the created_at

  Parameters

  • draft: Event | Helpers.EventTemplate | UnsignedEvent
  • ...operations: (undefined | EventOperation)[]

  Returns Promise<Helpers.EventTemplate>

modifyTags

• modifyTags(
      event: Event | Helpers.EventTemplate | UnsignedEvent,
      tagOperations?: ModifyTagsOptions,
      eventOperations?: EventOperation | (undefined | EventOperation)[],
  ): Promise<Helpers.EventTemplate>

  Modify a lists public and hidden tags and updated the created_at

  Parameters

  • event: Event | Helpers.EventTemplate | UnsignedEvent
  • OptionaltagOperations: ModifyTagsOptions
  • OptionaleventOperations: EventOperation | (undefined | EventOperation)[]

  Returns Promise<Helpers.EventTemplate>

note

• note(
      ...args: [content: string, options?: NoteBlueprintOptions],
  ): Promise<Helpers.EventTemplate>

  Creates a short text note

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

noteReply

• noteReply(
      ...args: [parent: Event, content: string, options?: TextContentOptions],
  ): Promise<Helpers.EventTemplate>

  Creates a short text note reply

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

reaction

• reaction(
      ...args: [event: Event, emoji: string | Helpers.Emoji],
  ): Promise<Helpers.EventTemplate>

  Creates a reaction event

  Parameters

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

  Returns Promise<Helpers.EventTemplate>

share

• share(
      ...args: [event: Event, options?: ShareBlueprintOptions],
  ): Promise<Helpers.EventTemplate>

  Creates a share event

  Parameters

  • ...args: [event: Event, options?: ShareBlueprintOptions]

  Returns Promise<Helpers.EventTemplate>

sign

• sign(draft: Helpers.EventTemplate | UnsignedEvent): Promise<Event>

  Signs a event template with the signer

  Parameters

  • draft: Helpers.EventTemplate | UnsignedEvent

  Returns Promise<Event>

stamp

• stamp(draft: Helpers.EventTemplate | UnsignedEvent): Promise<UnsignedEvent>

  Attaches the signers pubkey to an event template

  Parameters

  • draft: Helpers.EventTemplate | UnsignedEvent

  Returns Promise<UnsignedEvent>