Class EventFactory

constructor

• new EventFactory(context?: EventFactoryContext): EventFactory

  Parameters

  • context: EventFactoryContext = {}

  Returns EventFactory

context

build

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

  Build an event template with operations

  Parameters

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

  Returns Promise<EventTemplate>

comment

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

  Create a NIP-22 comment

  Parameters

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

  Returns Promise<EventTemplate>

create

• create<Args extends any[]>(
      blueprint: (...args: Args) => EventBlueprint,
      ...args: Args,
  ): Promise<EventTemplate>

  Create an event from a blueprint

  Type Parameters

  • Args extends any[]

  Parameters

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

  Returns Promise<EventTemplate>

delete

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

  Creates a delete event

  Parameters

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

  Returns Promise<EventTemplate>

modify

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

  Modify an existing event with operations and updated the created_at

  Parameters

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

  Returns Promise<EventTemplate>

modifyTags

• modifyTags(
      event: EventFactoryTemplate,
      tagOperations?:
          | TagOperation
          | TagOperation[]
          | {
              hidden?: TagOperation
              | TagOperation[];
              public?: TagOperation | TagOperation[];
          },
      eventOperations?: EventOperation | (undefined | EventOperation)[],
  ): 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: [content: string, options?: NoteBlueprintOptions],
  ): Promise<EventTemplate>

  Creates a short text note

  Parameters

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

  Returns Promise<EventTemplate>

noteReply

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

  Creates a short text note reply

  Parameters

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

  Returns Promise<EventTemplate>

process

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

  Build an event template with operations

  Parameters

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

  Returns Promise<EventTemplate>

  Deprecated

  use the build method instead

reaction

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

  Creates a reaction event

  Parameters

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

  Returns Promise<EventTemplate>

share

• share(...args: [event: Event]): Promise<EventTemplate>

  Creates a share event

  Parameters

  • ...args: [event: Event]

  Returns Promise<EventTemplate>

sign

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

  Parameters

  • draft: EventTemplate | UnsignedEvent

  Returns Promise<Event>

stamp

• stamp(draft: EventTemplate): Promise<UnsignedEvent>

  Attaches the signers pubkey to an event template

  Parameters

  • draft: EventTemplate

  Returns Promise<UnsignedEvent>

StaticrunProcess

• runProcess(
      template: EventFactoryTemplate,
      context: EventFactoryContext,
      ...operations: (undefined | EventOperation)[],
  ): Promise<EventTemplate>

  Parameters

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

  Returns Promise<EventTemplate>