Class EventFactory<K, T>

The base class for building or modifying events

Type Parameters

K extends number = number
T extends KnownEventTemplate<K> = KnownEventTemplate<K>

Hierarchy (View Summary)

Promise<T>
- EventFactory

Index

Constructors

constructor

new EventFactory<
    K extends number = number,
    T extends KnownEventTemplate<K> = KnownEventTemplate<K>,
>(
    executor: (
        resolve: (value: T | PromiseLike<T>) => void,
        reject: (reason?: any) => void,
    ) => void,
): EventFactory<K>
Creates a new Promise.
Type Parameters
- K extends number = number
- T extends KnownEventTemplate<K> = KnownEventTemplate<K>
Parameters
- executor: (
  resolve: (value: T | PromiseLike<T>) => void,
  reject: (reason?: any) => void,
  ) => void
  A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used to resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.
Returns EventFactory<K>
Inherited from Promise<T>.constructor
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:31

Properties

`Protected`_signerRef

_signerRef: SignerRef = {}

Shared mutable reference to the signer, propagated through all chain links

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Accessors

`Protected`signer

get signer(): EventSigner | undefined
The signer used to sign the event (reads from shared ref)

Returns EventSigner | undefined
- Defined in packages/core/src/factories/event.ts:60
set signer(value: EventSigner | undefined): void
Parameters
- value: EventSigner | undefined
Returns void
- Defined in packages/core/src/factories/event.ts:64

Methods

alt

alt(alt: string): EventFactory<K, T>
Sets the NIP-31 alt tag for the event
Parameters
- alt: string
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:166

as

as(signer: EventSigner): this
Sets the event signer to use when building this event
Parameters
- signer: EventSigner
Returns this
- Defined in packages/core/src/factories/event.ts:98

catch

catch<TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Inherited from Promise.catch
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1564

`Protected`chain

chain(operation: EventOperation<T>): this
Custom .then method that wraps the resulting promise in a new event factory
Parameters
- operation: EventOperation<T>
Returns this
- Defined in packages/core/src/factories/event.ts:69

content

content(content: string): EventFactory<K, T>
Sets the event content
Parameters
- content: string
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:150

contentWarning

contentWarning(warning: string | boolean): EventFactory<K, T>
Sets the NIP-36 content-warning tag for the event
Parameters
- warning: string | boolean
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:176

created

created(created?: number | Date): EventFactory<K, T>
Set the event created_at timestamp in seconds. if no value is provided, the current unix timestamp will be used
Parameters
- created: number | Date = ...
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:155

encryptedContent

encryptedContent(
    target: string,
    content: string,
    override?: EncryptionMethod,
): this
Sets the encrypted content of the event
Parameters
- target: string
- content: string
- Optionaloverride: EncryptionMethod
Returns this
- Defined in packages/core/src/factories/event.ts:205

expiration

expiration(timestamp: number): EventFactory<K, T>
Sets the NIP-40 expiration timestamp for the event
Parameters
- timestamp: number
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:171

finally

finally(onfinally?: (() => void) | null): Promise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: (() => void) | null
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
Inherited from Promise.finally
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

kind

kind<Kind extends number>(
kind: Kind,
): EventFactory<Kind, KnownEventTemplate<Kind>>
Sets the event kind and casts the result to a
Type Parameters
- Kind extends number
Parameters
- kind: Kind
Returns EventFactory<Kind, KnownEventTemplate<Kind>>
- Defined in packages/core/src/factories/event.ts:145

modifyHiddenTags

modifyHiddenTags(...args: TagOperation[]): this
Modifies the events hidden tags array
Parameters
- ...args: TagOperation[]
Returns this
- Defined in packages/core/src/factories/event.ts:198

modifyPublicTags

modifyPublicTags(...args: (TagOperation | undefined)[]): this
Modifies the events public tags array
Parameters
- ...args: (TagOperation | undefined)[]
Returns this
- Defined in packages/core/src/factories/event.ts:193

modifyTags

modifyTags(
...args: [tagOperations?: ModifyTagsOptions, signer?: EventSigner],
): this
Modifies the events public and optional hidden tags
Parameters
- ...args: [tagOperations?: ModifyTagsOptions, signer?: EventSigner]
Returns this
- Defined in packages/core/src/factories/event.ts:186

protected

protected(isProtected: boolean): EventFactory<K, T>
Sets the NIP-70 "-" tag for the event
Parameters
- isProtected: boolean
Returns EventFactory<K, T>
- Defined in packages/core/src/factories/event.ts:181

sign

sign(signer?: EventSigner | undefined): Promise<KnownEvent<K>>
Signs the event using a signer interface and returns a Promise
Parameters
- signer: EventSigner | undefined = ...
Returns Promise<KnownEvent<K>>
- Defined in packages/core/src/factories/event.ts:126

stamp

stamp(signer?: EventSigner | undefined): EventFactory<K, KnownUnsignedEvent<K>>
Stamps the pubkey onto the event template
Parameters
- signer: EventSigner | undefined = ...
Returns EventFactory<K, KnownUnsignedEvent<K>>
- Defined in packages/core/src/factories/event.ts:118

strip

strip(): EventFactory<K>
Strips the pubkey, sig, and id from the event

Returns EventFactory<K>
- Defined in packages/core/src/factories/event.ts:104

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null
  The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from Promise.then
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1557

`Static`all

all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>[]>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:255
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
    values: T,
): Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P]>>
    },
>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P]>>
    },
>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.promise.d.ts:38
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): Promise<PromiseSettledResult<Awaited<T>>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`Static`any

any<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array or iterable of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array or iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`Static`fromEvent

fromEvent<K extends number = number>(
event: KnownEvent<K>,
): EventFactory<K, KnownEventTemplate<K>>
Create a new event factory from a nostr event
Type Parameters
- K extends number = number
Parameters
- event: KnownEvent<K>
Returns EventFactory<K, KnownEventTemplate<K>>
- Defined in packages/core/src/factories/event.ts:52

`Static`fromKind

fromKind<K extends number>(kind: K): EventFactory<K>
Create a new event factory from a kind
Type Parameters
- K extends number
Parameters
- kind: K
Returns EventFactory<K>
- Defined in packages/core/src/factories/event.ts:47

`Static`race

race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:263
race<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:50

`Static`reject

reject<T = never>(reason?: any): Promise<T>
Creates a new rejected promise for the provided reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
  The reason the promise was rejected.
Returns Promise<T>
A new rejected Promise.
Inherited from Promise.reject
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:60

`Static`resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns Promise<void>
A resolved promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:66
resolve<T>(value: T): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:72
resolve<T>(value: T | PromiseLike<T>): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

Class EventFactory<K, T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EventFactory<K>

Properties

Protected_signerRef

Readonly[toStringTag]

Static Readonly[species]

Accessors

Protectedsigner

Returns EventSigner | undefined

Parameters

Returns void

Methods

alt

Parameters

Returns EventFactory<K, T>

as

Parameters

Returns this

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

Protectedchain

Parameters

Returns this

content

Parameters

Returns EventFactory<K, T>

contentWarning

Parameters

Returns EventFactory<K, T>

created

Parameters

Returns EventFactory<K, T>

encryptedContent

Parameters

Returns this

expiration

Parameters

Returns EventFactory<K, T>

finally

Parameters

Returns Promise<T>

kind

Type Parameters

Parameters

Returns EventFactory<Kind, KnownEventTemplate<Kind>>

meta

Parameters

Returns EventFactory<K, T>

modifyHiddenTags

Parameters

Returns this

modifyPublicTags

Parameters

Returns this

modifyTags

Parameters

Returns this

protected

Parameters

Returns EventFactory<K, T>

sign

Parameters

Returns Promise<KnownEvent<K>>

stamp

Parameters

Returns EventFactory<K, KnownUnsignedEvent<K>>

strip

`Protected`_signerRef

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Protected`signer

`Protected`chain

`Static`all

`Static`allSettled

Returns Promise<
{
-readonly [P in string
| number
| symbol]: PromiseSettledResult<Awaited<T[P]>>
},
>

`Static`any

`Static`fromEvent

`Static`fromKind

`Static`race

`Static`reject

`Static`resolve