Class NDKArticle

content

Optional created_at

decrypt

encode

encrypt

id

isEphemeral

isParamReplaceable

isReplaceable

Optional kind

Optional ndk

onRelays

pubkey

relay

repost

Optional sig

tags

alt

• get alt(): undefined | string

• Gets the NIP-31 "alt" tag of the event.

  Returns undefined | string
• set alt(alt: undefined | string): void

• Sets the NIP-31 "alt" tag of the event. Use this to set an alt tag so clients that don't handle a particular event kind can display something useful for users.

  Parameters

  • alt: undefined | string

  Returns void

author

• get author(): NDKUser

• Returns an NDKUser for the author of the event.

  Returns NDKUser
• set author(user: NDKUser): void

• Parameters

  • user: NDKUser

  Returns void

dTag

• get dTag(): undefined | string

• Gets the NIP-33 "d" tag of the event.

  Returns undefined | string
• set dTag(value: undefined | string): void

• Sets the NIP-33 "d" tag of the event.

  Parameters

  • value: undefined | string

  Returns void

isValid

• get isValid(): boolean

• Checks whether the event is valid per underlying NIPs.

  This method is meant to be overridden by subclasses that implement specific NIPs to allow the enforcement of NIP-specific validation rules.

  Returns boolean

deduplicationKey

• deduplicationKey(): string

• Provides a deduplication key for the event.

  For kinds 0, 3, 10k-20k this will be the event : For kinds 30k-40k this will be the event :: For all other kinds this will be the event id

  Returns string

delete

• delete(reason?: string, publish?: boolean): Promise<NDKEvent>

• Generates a deletion event of the current event

  Parameters

  • Optional reason: string

    The reason for the deletion

  • publish: boolean = true

    Whether to publish the deletion event automatically

  Returns Promise<NDKEvent>

  The deletion event

filter

• filter(): NDKFilter

• Provides the filter that will return matching events for this event.

  Returns NDKFilter

  The filter that will return matching events for this event

  Example

  event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
     event.filter(); // { "#a": ["30000:pubkey:d-code"] }
  Copy

  Example

  event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
     event.filter(); // { "#e": ["eventid"] }
  Copy

getMatchingTags

• getMatchingTags(tagName: string): NDKTag[]

• Get all tags with the given name

  Parameters

  • tagName: string

    {string} The name of the tag to search for

  Returns NDKTag[]

  An array of the matching tags

muted

• muted(): null | string

• Returns null | string

publish

• publish(relaySet?: NDKRelaySet, timeoutMs?: number): Promise<Set<NDKRelay>>

• Attempt to sign and then publish an NDKEvent to a given relaySet. If no relaySet is provided, the relaySet will be calculated by NDK.

  Parameters

  • Optional relaySet: NDKRelaySet

    {NDKRelaySet} The relaySet to publish the even to.

  • Optional timeoutMs: number

  Returns Promise<Set<NDKRelay>>

  A promise that resolves to the relays the event was published to.

rawEvent

• rawEvent(): NostrEvent

• Returns the event as is.

  Returns NostrEvent

react

• react(content: string, publish?: boolean): Promise<NDKEvent>

• React to an existing event

  Parameters

  • content: string

    The content of the reaction

  • publish: boolean = true

  Returns Promise<NDKEvent>

referenceTags

• referenceTags(marker?: string, skipAuthorTag?: boolean): NDKTag[]

• Get the tags that can be used to reference this event from another event

  Parameters

  • Optional marker: string

    The marker to use in the tag

  • Optional skipAuthorTag: boolean

  Returns NDKTag[]

  The NDKTag object referencing this event

  Example

  event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
      event.referenceTags(); // [["a", "30000:pubkey:d-code"], ["e", "parent-id"]]
  
      event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
      event.referenceTags(); // [["e", "parent-id"]]
  Copy

removeTag

• removeTag(tagName: string): void

• Remove all tags with the given name (e.g. "d", "a", "p")

  Parameters

  • tagName: string

    Tag name to search for and remove

  Returns void

replaceableDTag

• replaceableDTag(): string

• Returns the "d" tag of a parameterized replaceable event or throws an error if the event isn't a parameterized replaceable event.

  Returns string

  the "d" tag of the event.

sign

• sign(signer?: NDKSigner): Promise<string>

• Sign the event if a signer is present.

  It will generate tags. Repleacable events will have their created_at field set to the current time.

  Parameters

  • Optional signer: NDKSigner

    {NDKSigner} The NDKSigner to use to sign the event

  Returns Promise<string>

  A Promise that resolves to the signature of the signed event.

tag

• tag(user: NDKUser, marker?: string): void

• Tag a user with an optional marker.

  Parameters

  • user: NDKUser

    The user to tag.

  • Optional marker: string

    The marker to use in the tag.

  Returns void
• tag(user: NDKUser, marker?: string): void

• Tag a user with an optional marker.

  Parameters

  • user: NDKUser

    The user to tag.

  • Optional marker: string

    The marker to use in the tag.

  Returns void
• tag(event: NDKEvent, marker?: string, skipAuthorTag?: boolean): void

• Tag a user with an optional marker.

  Parameters

  • event: NDKEvent

    The event to tag.

  • Optional marker: string

    The marker to use in the tag.

  • Optional skipAuthorTag: boolean

    Whether to explicitly skip adding the author tag of the event.

  Returns void

  Example

  reply.tag(opEvent, "reply");
  // reply.tags => [["e", <id>, <relay>, "reply"]]
  Copy

tagAddress

• tagAddress(): string

• Returns the "reference" value ("::") for this replaceable event.

  Returns string

  The id

tagId

• tagId(): string

• Returns the id of the event or, if it's a parameterized event, the generated id of the event using "d" tag, pubkey, and kind.

  Returns string

  The id

tagReference

• tagReference(marker?: string): NDKTag

• Get the tag that can be used to reference this event from another event.

  Consider using referenceTags() instead (unless you have a good reason to use this)

  Parameters

  • Optional marker: string

  Returns NDKTag

  The NDKTag object referencing this event

  Example

  event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
      event.tagReference(); // ["a", "30000:pubkey:d-code"]
  
      event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
      event.tagReference(); // ["e", "eventid"]
  Copy

tagValue

• tagValue(tagName: string): undefined | string

• Get the first tag with the given name

  Parameters

  • tagName: string

    Tag name to search for

  Returns undefined | string

  The value of the first tag with the given name, or undefined if no such tag exists

toNostrEvent

• toNostrEvent(pubkey?: string): Promise<NostrEvent>

• Return a NostrEvent object, trying to fill in missing fields when possible, adding tags when necessary.

  Parameters

  • Optional pubkey: string

    {string} The pubkey of the user who the event belongs to.

  Returns Promise<NostrEvent>

  A promise that resolves to a NostrEvent.

zap

• zap(amount: number, comment?: string, extraTags?: NDKTag[], recipient?: NDKUser, signer?: NDKSigner): Promise<null | string>

• Create a zap request for an existing event

  Parameters

  • amount: number

    The amount to zap in millisatoshis

  • Optional comment: string

    A comment to add to the zap request

  • Optional extraTags: NDKTag[]

    Extra tags to add to the zap request

  • Optional recipient: NDKUser

    The zap recipient (optional for events)

  • Optional signer: NDKSigner

    The signer to use (will default to the NDK instance's signer)

  Returns Promise<null | string>