nostr package: vastly simplify the API #412

Merged
sistemd merged 27 commits from nostr-package-use-methods-for-events into main 2023-03-27 09:09:48 +00:00
Showing only changes of commit 9b03c4d2ed - Show all commits

View File

@ -11,10 +11,11 @@ export class EventEmitter extends Base {
eventName: "removeListener", eventName: "removeListener",
listener: RemoveListener listener: RemoveListener
): this ): this
override addListener(eventName: "event", listener: EventListener): this
override addListener(eventName: "notice", listener: NoticeListener): this override addListener(eventName: "notice", listener: NoticeListener): this
override addListener(eventName: "ok", listener: OkListener): this override addListener(eventName: "ok", listener: OkListener): this
override addListener(eventName: "eose", listener: EoseListener): this
override addListener(eventName: "error", listener: ErrorListener): this override addListener(eventName: "error", listener: ErrorListener): this
override addListener(eventName: "newListener", listener: ErrorListener): this
override addListener(eventName: EventName, listener: Listener): this { override addListener(eventName: EventName, listener: Listener): this {
return super.addListener(eventName, listener) return super.addListener(eventName, listener)
} }
@ -24,6 +25,11 @@ export class EventEmitter extends Base {
override emit(eventName: "event", params: EventParams, nostr: Nostr): boolean override emit(eventName: "event", params: EventParams, nostr: Nostr): boolean
override emit(eventName: "notice", notice: string, nostr: Nostr): boolean override emit(eventName: "notice", notice: string, nostr: Nostr): boolean
override emit(eventName: "ok", params: OkParams, nostr: Nostr): boolean override emit(eventName: "ok", params: OkParams, nostr: Nostr): boolean
override emit(
eventName: "eose",
subscriptionId: SubscriptionId,
nostr: Nostr
): boolean
override emit(eventName: "error", err: unknown, nostr: Nostr): boolean override emit(eventName: "error", err: unknown, nostr: Nostr): boolean
override emit(eventName: EventName, ...args: unknown[]): boolean { override emit(eventName: EventName, ...args: unknown[]): boolean {
return super.emit(eventName, ...args) return super.emit(eventName, ...args)
@ -38,6 +44,7 @@ export class EventEmitter extends Base {
override listeners(eventName: "event"): EventListener[] override listeners(eventName: "event"): EventListener[]
override listeners(eventName: "notice"): NoticeListener[] override listeners(eventName: "notice"): NoticeListener[]
override listeners(eventName: "ok"): OkListener[] override listeners(eventName: "ok"): OkListener[]
override listeners(eventName: "eose"): EoseListener[]
override listeners(eventName: "error"): ErrorListener[] override listeners(eventName: "error"): ErrorListener[]
override listeners(eventName: EventName): Listener[] { override listeners(eventName: EventName): Listener[] {
return super.listeners(eventName) as Listener[] return super.listeners(eventName) as Listener[]
@ -48,6 +55,7 @@ export class EventEmitter extends Base {
override off(eventName: "event", listener: EventListener): this override off(eventName: "event", listener: EventListener): this
override off(eventName: "notice", listener: NoticeListener): this override off(eventName: "notice", listener: NoticeListener): this
override off(eventName: "ok", listener: OkListener): this override off(eventName: "ok", listener: OkListener): this
override off(eventName: "eose", listener: EoseListener): this
override off(eventName: "error", listener: ErrorListener): this override off(eventName: "error", listener: ErrorListener): this
override off(eventName: EventName, listener: Listener): this { override off(eventName: EventName, listener: Listener): this {
return super.off(eventName, listener) return super.off(eventName, listener)
@ -58,6 +66,7 @@ export class EventEmitter extends Base {
override on(eventName: "event", listener: EventListener): this override on(eventName: "event", listener: EventListener): this
override on(eventName: "notice", listener: NoticeListener): this override on(eventName: "notice", listener: NoticeListener): this
override on(eventName: "ok", listener: OkListener): this override on(eventName: "ok", listener: OkListener): this
override on(eventName: "eose", listener: EoseListener): this
override on(eventName: "error", listener: ErrorListener): this override on(eventName: "error", listener: ErrorListener): this
override on(eventName: EventName, listener: Listener): this { override on(eventName: EventName, listener: Listener): this {
return super.on(eventName, listener) return super.on(eventName, listener)
@ -68,6 +77,7 @@ export class EventEmitter extends Base {
override once(eventName: "event", listener: EventListener): this override once(eventName: "event", listener: EventListener): this
override once(eventName: "notice", listener: NoticeListener): this override once(eventName: "notice", listener: NoticeListener): this
override once(eventName: "ok", listener: OkListener): this override once(eventName: "ok", listener: OkListener): this
override once(eventName: "eose", listener: EoseListener): this
override once(eventName: "error", listener: ErrorListener): this override once(eventName: "error", listener: ErrorListener): this
override once(eventName: EventName, listener: Listener): this { override once(eventName: EventName, listener: Listener): this {
return super.once(eventName, listener) return super.once(eventName, listener)
@ -84,6 +94,7 @@ export class EventEmitter extends Base {
override prependListener(eventName: "event", listener: EventListener): this override prependListener(eventName: "event", listener: EventListener): this
override prependListener(eventName: "notice", listener: NoticeListener): this override prependListener(eventName: "notice", listener: NoticeListener): this
override prependListener(eventName: "ok", listener: OkListener): this override prependListener(eventName: "ok", listener: OkListener): this
override prependListener(eventName: "eose", listener: EoseListener): this
override prependListener(eventName: "error", listener: ErrorListener): this override prependListener(eventName: "error", listener: ErrorListener): this
override prependListener(eventName: EventName, listener: Listener): this { override prependListener(eventName: EventName, listener: Listener): this {
return super.prependListener(eventName, listener) return super.prependListener(eventName, listener)
@ -106,6 +117,7 @@ export class EventEmitter extends Base {
listener: NoticeListener listener: NoticeListener
): this ): this
override prependOnceListener(eventName: "ok", listener: OkListener): this override prependOnceListener(eventName: "ok", listener: OkListener): this
override prependOnceListener(eventName: "eose", listener: EoseListener): this
override prependOnceListener( override prependOnceListener(
eventName: "error", eventName: "error",
listener: ErrorListener listener: ErrorListener
@ -126,6 +138,7 @@ export class EventEmitter extends Base {
override removeListener(eventName: "event", listener: EventListener): this override removeListener(eventName: "event", listener: EventListener): this
override removeListener(eventName: "notice", listener: NoticeListener): this override removeListener(eventName: "notice", listener: NoticeListener): this
override removeListener(eventName: "ok", listener: OkListener): this override removeListener(eventName: "ok", listener: OkListener): this
override removeListener(eventName: "eose", listener: EoseListener): this
override removeListener(eventName: "error", listener: ErrorListener): this override removeListener(eventName: "error", listener: ErrorListener): this
override removeListener(eventName: EventName, listener: Listener): this { override removeListener(eventName: EventName, listener: Listener): this {
return super.removeListener(eventName, listener) return super.removeListener(eventName, listener)
@ -139,21 +152,21 @@ export class EventEmitter extends Base {
// emitter[Symbol.for('nodejs.rejection')](err, eventName[, ...args]) shenanigans? // emitter[Symbol.for('nodejs.rejection')](err, eventName[, ...args]) shenanigans?
} }
// TODO Also add on: ("subscribed", subscriptionId) which checks "OK"/"NOTICE" and makes a callback?
// TODO Also add on: ("ok", boolean, eventId) which checks "OK"/"NOTICE" and makes a callback?
type EventName = type EventName =
| "newListener" | "newListener"
| "removeListener" | "removeListener"
| "event" | "event"
| "notice" | "notice"
| "ok" | "ok"
| "eose"
| "error" | "error"
type NewListener = (eventName: EventName, listener: Listener) => void type NewListener = (eventName: EventName, listener: Listener) => void
type RemoveListener = (eventName: EventName, listener: Listener) => void type RemoveListener = (eventName: EventName, listener: Listener) => void
type EventListener = (params: EventParams, nostr: Nostr) => void type EventListener = (params: EventParams, nostr: Nostr) => void
type OkListener = (params: OkParams, nostr: Nostr) => void
type NoticeListener = (notice: string, nostr: Nostr) => void type NoticeListener = (notice: string, nostr: Nostr) => void
type OkListener = (params: OkParams, nostr: Nostr) => void
type EoseListener = (subscriptionId: SubscriptionId, nostr: Nostr) => void
type ErrorListener = (error: unknown, nostr: Nostr) => void type ErrorListener = (error: unknown, nostr: Nostr) => void
type Listener = type Listener =
@ -162,6 +175,7 @@ type Listener =
| EventListener | EventListener
| NoticeListener | NoticeListener
| OkListener | OkListener
| EoseListener
| ErrorListener | ErrorListener
// TODO Document this // TODO Document this