From 83a51a8514ae66c7e3952532320796d821c08aa2 Mon Sep 17 00:00:00 2001 From: CodyTseng <64680921+CodyTseng@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:40:46 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20CodyTsen?= =?UTF-8?q?g/nostr-relay@d818d4cf57c81bbf523cd6c2e4e58fb4fba3d620=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/_nostr_relay_common.BaseError.html | 2 +- .../_nostr_relay_common.ClientContext.html | 14 ++++++------ ...str_relay_common.ConsoleLoggerService.html | 4 ++-- .../_nostr_relay_common.EventRepository.html | 10 ++++----- classes/_nostr_relay_common.EventUtils.html | 4 ++-- classes/_nostr_relay_common.FilterUtils.html | 4 ++-- .../_nostr_relay_common.InternalError.html | 2 +- classes/_nostr_relay_core.NostrRelay.html | 22 +++++++++---------- ...pository_sqlite.EventRepositorySqlite.html | 12 +++++----- classes/_nostr_relay_validator.Validator.html | 10 ++++----- ...nostr_relay_common.countPowDifficulty.html | 2 +- ...tr_relay_common.getTimestampInSeconds.html | 2 +- functions/_nostr_relay_common.isNil.html | 2 +- .../_nostr_relay_common.isUndefined.html | 2 +- .../_nostr_relay_common.schnorrSign.html | 2 +- .../_nostr_relay_common.schnorrVerify.html | 2 +- functions/_nostr_relay_common.sha256.html | 2 +- ..._relay_core.createOutgoingAuthMessage.html | 2 +- ...elay_core.createOutgoingClosedMessage.html | 2 +- ..._relay_core.createOutgoingEoseMessage.html | 2 +- ...relay_core.createOutgoingEventMessage.html | 2 +- ...elay_core.createOutgoingNoticeMessage.html | 2 +- ...tr_relay_core.createOutgoingOkMessage.html | 2 +- ...ostr_relay_common.AfterEventBroadcast.html | 4 ++-- .../_nostr_relay_common.AfterEventHandle.html | 4 ++-- ...str_relay_common.BeforeEventBroadcast.html | 4 ++-- ..._nostr_relay_common.BeforeEventHandle.html | 4 ++-- interfaces/_nostr_relay_common.Client.html | 4 ++-- interfaces/_nostr_relay_common.Event.html | 4 ++-- ...ay_common.EventRepositoryUpsertResult.html | 4 ++-- interfaces/_nostr_relay_common.Filter.html | 4 ++-- interfaces/_nostr_relay_common.Logger.html | 4 ++-- modules/_nostr_relay_common.html | 2 +- modules/_nostr_relay_core.html | 2 +- .../_nostr_relay_event_repository_sqlite.html | 2 +- modules/_nostr_relay_validator.html | 2 +- ..._relay_common.BeforeEventHandleResult.html | 2 +- .../_nostr_relay_common.BeforeHookResult.html | 2 +- ...str_relay_common.ClientContextOptions.html | 2 +- .../_nostr_relay_common.ClientReadyState.html | 2 +- ..._nostr_relay_common.EventHandleResult.html | 2 +- types/_nostr_relay_common.EventId.html | 2 +- types/_nostr_relay_common.EventKind.html | 2 +- types/_nostr_relay_common.EventType.html | 2 +- ...ostr_relay_common.IncomingAuthMessage.html | 2 +- ...str_relay_common.IncomingCloseMessage.html | 2 +- ...str_relay_common.IncomingEventMessage.html | 2 +- .../_nostr_relay_common.IncomingMessage.html | 2 +- ...nostr_relay_common.IncomingReqMessage.html | 2 +- types/_nostr_relay_common.LogLevel.html | 2 +- types/_nostr_relay_common.MessageType.html | 2 +- .../_nostr_relay_common.NostrRelayPlugin.html | 2 +- ...ostr_relay_common.OutgoingAuthMessage.html | 2 +- ...tr_relay_common.OutgoingClosedMessage.html | 2 +- ...ostr_relay_common.OutgoingEoseMessage.html | 2 +- ...str_relay_common.OutgoingEventMessage.html | 2 +- .../_nostr_relay_common.OutgoingMessage.html | 2 +- ...tr_relay_common.OutgoingNoticeMessage.html | 2 +- ..._nostr_relay_common.OutgoingOkMessage.html | 2 +- types/_nostr_relay_common.Pubkey.html | 2 +- types/_nostr_relay_common.Signature.html | 2 +- types/_nostr_relay_common.SubscriptionId.html | 2 +- types/_nostr_relay_common.Tag.html | 2 +- types/_nostr_relay_common.TagName.html | 2 +- ...tr_relay_core.HandleAuthMessageResult.html | 2 +- ...r_relay_core.HandleCloseMessageResult.html | 2 +- ...r_relay_core.HandleEventMessageResult.html | 2 +- ..._nostr_relay_core.HandleMessageResult.html | 2 +- ...str_relay_core.HandleReqMessageResult.html | 2 +- .../_nostr_relay_core.NostrRelayOptions.html | 2 +- types/_nostr_relay_validator.RawData.html | 2 +- ...ay_validator.RequiredValidatorOptions.html | 2 +- ...ostr_relay_validator.ValidatorOptions.html | 2 +- ...nostr_relay_common.ClientReadyState-1.html | 2 +- .../_nostr_relay_common.EventKind-1.html | 2 +- .../_nostr_relay_common.EventType-1.html | 2 +- variables/_nostr_relay_common.LogLevel-1.html | 2 +- .../_nostr_relay_common.MessageType-1.html | 2 +- variables/_nostr_relay_common.TagName-1.html | 2 +- 79 files changed, 120 insertions(+), 120 deletions(-) diff --git a/classes/_nostr_relay_common.BaseError.html b/classes/_nostr_relay_common.BaseError.html index 7b4b8637..2bc5580a 100644 --- a/classes/_nostr_relay_common.BaseError.html +++ b/classes/_nostr_relay_common.BaseError.html @@ -1,4 +1,4 @@ -BaseError | nostr-relay

Hierarchy (view full)

Constructors

constructor +BaseError | nostr-relay

Hierarchy (view full)

Constructors

Properties

message name stack? diff --git a/classes/_nostr_relay_common.ClientContext.html b/classes/_nostr_relay_common.ClientContext.html index ad18af26..341451fe 100644 --- a/classes/_nostr_relay_common.ClientContext.html +++ b/classes/_nostr_relay_common.ClientContext.html @@ -1,5 +1,5 @@ ClientContext | nostr-relay

Client context.

-

Constructors

Constructors

Properties

id pubkey subscriptions @@ -8,10 +8,10 @@

Constructors

Properties

id: string

Client ID, a random UUID. Also used as the AUTH challenge.

-
pubkey: undefined | string

Public key of the client. Will be set after the client sends an AUTH message.

-
subscriptions: LRUCache<string, Filter[]>

Subscriptions of the client. The key is the subscription ID. The value is the filters.

-

Accessors

Methods

  • Send a message to the client. It will be ignored if the client is not open.

    +

Returns ClientContext

Properties

id: string

Client ID, a random UUID. Also used as the AUTH challenge.

+
pubkey: undefined | string

Public key of the client. Will be set after the client sends an AUTH message.

+
subscriptions: LRUCache<string, Filter[], unknown>

Subscriptions of the client. The key is the subscription ID. The value is the filters.

+

Accessors

Methods

Generated using TypeDoc

\ No newline at end of file +

Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_nostr_relay_common.ConsoleLoggerService.html b/classes/_nostr_relay_common.ConsoleLoggerService.html index 0ce029e5..b6d4357f 100644 --- a/classes/_nostr_relay_common.ConsoleLoggerService.html +++ b/classes/_nostr_relay_common.ConsoleLoggerService.html @@ -1,7 +1,7 @@ -ConsoleLoggerService | nostr-relay

Implements

Constructors

constructor +ConsoleLoggerService | nostr-relay

Implements

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_nostr_relay_common.EventRepository.html b/classes/_nostr_relay_common.EventRepository.html index e99fa7c3..4df3e1ad 100644 --- a/classes/_nostr_relay_common.EventRepository.html +++ b/classes/_nostr_relay_common.EventRepository.html @@ -1,19 +1,19 @@ EventRepository | nostr-relay

Class EventRepositoryAbstract

EventRepository is an interface for storing and retrieving events. You can implement this interface to create your own event repository based on your favorite database.

-

Hierarchy

  • EventRepository

    Constructors

    Hierarchy

    • EventRepository

      Constructors

      Properties

      Methods

      Constructors

      Properties

      isSearchSupported: boolean = false

      This property indicates whether the search feature is supported.

      -

      Methods

      Methods

      • This method doesn't need to be implemented. It's just a helper method for +

      Returns Event[] | Promise<Event[]>

      Returns Promise<null | Event>

      Generated using TypeDoc

      \ No newline at end of file +

      Returns EventRepositoryUpsertResult | Promise<EventRepositoryUpsertResult>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/_nostr_relay_common.EventUtils.html b/classes/_nostr_relay_common.EventUtils.html index 43fee609..c2ebeada 100644 --- a/classes/_nostr_relay_common.EventUtils.html +++ b/classes/_nostr_relay_common.EventUtils.html @@ -1,4 +1,4 @@ -EventUtils | nostr-relay

      Constructors

      constructor +EventUtils | nostr-relay

      Constructors

      Methods

      • Parameters

        • event: Event
        • options: {
              createdAtLowerLimit?: number;
              createdAtUpperLimit?: number;
              minPowDifficulty?: number;
          } = {}
          • Optional createdAtLowerLimit?: number
          • Optional createdAtUpperLimit?: number
          • Optional minPowDifficulty?: number

        Returns undefined | string

      Generated using TypeDoc

      \ No newline at end of file +

      Constructors

      Methods

      • Parameters

        • event: Event
        • options: {
              createdAtLowerLimit?: number;
              createdAtUpperLimit?: number;
              minPowDifficulty?: number;
          } = {}
          • Optional createdAtLowerLimit?: number
          • Optional createdAtUpperLimit?: number
          • Optional minPowDifficulty?: number

        Returns undefined | string

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/_nostr_relay_common.FilterUtils.html b/classes/_nostr_relay_common.FilterUtils.html index acc68d8a..2d2e725c 100644 --- a/classes/_nostr_relay_common.FilterUtils.html +++ b/classes/_nostr_relay_common.FilterUtils.html @@ -1,3 +1,3 @@ -FilterUtils | nostr-relay

      Constructors

      constructor +FilterUtils | nostr-relay

      Constructors

      Methods

      Generated using TypeDoc

      \ No newline at end of file +

      Constructors

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/_nostr_relay_common.InternalError.html b/classes/_nostr_relay_common.InternalError.html index 6a841f6a..53731979 100644 --- a/classes/_nostr_relay_common.InternalError.html +++ b/classes/_nostr_relay_common.InternalError.html @@ -1,4 +1,4 @@ -InternalError | nostr-relay

      Hierarchy (view full)

      Constructors

      constructor +InternalError | nostr-relay

      Hierarchy (view full)

      Constructors

      Properties

      message name stack? diff --git a/classes/_nostr_relay_core.NostrRelay.html b/classes/_nostr_relay_core.NostrRelay.html index aac47093..a2093ec6 100644 --- a/classes/_nostr_relay_core.NostrRelay.html +++ b/classes/_nostr_relay_core.NostrRelay.html @@ -1,4 +1,4 @@ -NostrRelay | nostr-relay

      Constructors

      constructor +NostrRelay | nostr-relay

      Constructors

      Methods

      Constructors

      Methods

      Returns NostrRelay

      Methods

      Returns HandleAuthMessageResult

      • Handle a new client connection. This method should be called when a new +

      Returns HandleCloseMessageResult

      • Handle a new client connection. This method should be called when a new client connects to the Nostr Relay server.

        Parameters

        • client: Client

          Client instance, usually a WebSocket

          -

        Returns void

      • Handle a client disconnection. This method should be called when a client +

      Returns void

      • Handle a client disconnection. This method should be called when a client disconnects from the Nostr Relay server.

        Parameters

        • client: Client

          Client instance, usually a WebSocket

          -

        Returns void

      Returns void

      • Handle an incoming message from a client. It can be an EVENT, REQ, CLOSE, +

      Returns Promise<HandleEventMessageResult>

      Returns Promise<HandleMessageResult>

      Returns Promise<HandleReqMessageResult>

      Returns boolean

      Generated using TypeDoc

      \ No newline at end of file +

      Returns NostrRelay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/_nostr_relay_event_repository_sqlite.EventRepositorySqlite.html b/classes/_nostr_relay_event_repository_sqlite.EventRepositorySqlite.html index 6f95bfbb..43e30ff1 100644 --- a/classes/_nostr_relay_event_repository_sqlite.EventRepositorySqlite.html +++ b/classes/_nostr_relay_event_repository_sqlite.EventRepositorySqlite.html @@ -1,21 +1,21 @@ EventRepositorySqlite | nostr-relay

      EventRepository is an interface for storing and retrieving events. You can implement this interface to create your own event repository based on your favorite database.

      -

      Hierarchy (view full)

      Constructors

      Hierarchy (view full)

      Constructors

      Properties

      isSearchSupported: boolean

      This property indicates whether the search feature is supported.

      -

      Methods

      • This method is called when a client requests events.

        +

      Constructors

      Properties

      isSearchSupported: boolean

      This property indicates whether the search feature is supported.

      +

      Methods

      • This method doesn't need to be implemented. It's just a helper method for +

      Returns Promise<Event[]>

      Returns Promise<null | Event>

      Generated using TypeDoc

      \ No newline at end of file +

      Returns Promise<EventRepositoryUpsertResult>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/_nostr_relay_validator.Validator.html b/classes/_nostr_relay_validator.Validator.html index 234e4d8a..974cc89c 100644 --- a/classes/_nostr_relay_validator.Validator.html +++ b/classes/_nostr_relay_validator.Validator.html @@ -1,14 +1,14 @@ Validator | nostr-relay

      Zod based validator for Nostr Relay messages

      -

      Constructors

      Constructors

      Methods

      • Validate event

        +

      Returns Validator

      Methods

      • Validate filter

        +

      Returns Promise<Event>

      Returns Promise<Filter>

      Generated using TypeDoc

      \ No newline at end of file +

      Returns Promise<IncomingMessage>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.countPowDifficulty.html b/functions/_nostr_relay_common.countPowDifficulty.html index 3386ab6c..a3835472 100644 --- a/functions/_nostr_relay_common.countPowDifficulty.html +++ b/functions/_nostr_relay_common.countPowDifficulty.html @@ -1 +1 @@ -countPowDifficulty | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +countPowDifficulty | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.getTimestampInSeconds.html b/functions/_nostr_relay_common.getTimestampInSeconds.html index ab8a9097..a2a2175f 100644 --- a/functions/_nostr_relay_common.getTimestampInSeconds.html +++ b/functions/_nostr_relay_common.getTimestampInSeconds.html @@ -1 +1 @@ -getTimestampInSeconds | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +getTimestampInSeconds | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.isNil.html b/functions/_nostr_relay_common.isNil.html index 4388b7f0..7ca8858b 100644 --- a/functions/_nostr_relay_common.isNil.html +++ b/functions/_nostr_relay_common.isNil.html @@ -1 +1 @@ -isNil | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +isNil | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.isUndefined.html b/functions/_nostr_relay_common.isUndefined.html index 08b2ad6d..1fca1735 100644 --- a/functions/_nostr_relay_common.isUndefined.html +++ b/functions/_nostr_relay_common.isUndefined.html @@ -1 +1 @@ -isUndefined | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +isUndefined | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.schnorrSign.html b/functions/_nostr_relay_common.schnorrSign.html index 474f4914..ad706d19 100644 --- a/functions/_nostr_relay_common.schnorrSign.html +++ b/functions/_nostr_relay_common.schnorrSign.html @@ -1 +1 @@ -schnorrSign | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +schnorrSign | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.schnorrVerify.html b/functions/_nostr_relay_common.schnorrVerify.html index abf9a1b2..6bfdee47 100644 --- a/functions/_nostr_relay_common.schnorrVerify.html +++ b/functions/_nostr_relay_common.schnorrVerify.html @@ -1 +1 @@ -schnorrVerify | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +schnorrVerify | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_common.sha256.html b/functions/_nostr_relay_common.sha256.html index 98d68a38..77d76ae9 100644 --- a/functions/_nostr_relay_common.sha256.html +++ b/functions/_nostr_relay_common.sha256.html @@ -1 +1 @@ -sha256 | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +sha256 | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingAuthMessage.html b/functions/_nostr_relay_core.createOutgoingAuthMessage.html index 9a93ac6a..587431de 100644 --- a/functions/_nostr_relay_core.createOutgoingAuthMessage.html +++ b/functions/_nostr_relay_core.createOutgoingAuthMessage.html @@ -1,4 +1,4 @@ createOutgoingAuthMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingAuthMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingClosedMessage.html b/functions/_nostr_relay_core.createOutgoingClosedMessage.html index b8ab1e9d..7903dd65 100644 --- a/functions/_nostr_relay_core.createOutgoingClosedMessage.html +++ b/functions/_nostr_relay_core.createOutgoingClosedMessage.html @@ -2,4 +2,4 @@ More info: https://github.com/nostr-protocol/nips/blob/master/01.md

      Parameters

      Returns OutgoingClosedMessage

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingClosedMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingEoseMessage.html b/functions/_nostr_relay_core.createOutgoingEoseMessage.html index f8fa0c5e..2721cef6 100644 --- a/functions/_nostr_relay_core.createOutgoingEoseMessage.html +++ b/functions/_nostr_relay_core.createOutgoingEoseMessage.html @@ -1,4 +1,4 @@ createOutgoingEoseMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingEoseMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingEventMessage.html b/functions/_nostr_relay_core.createOutgoingEventMessage.html index 17388779..91f6adaf 100644 --- a/functions/_nostr_relay_core.createOutgoingEventMessage.html +++ b/functions/_nostr_relay_core.createOutgoingEventMessage.html @@ -2,4 +2,4 @@ More info: https://github.com/nostr-protocol/nips/blob/master/01.md

      Parameters

      Returns OutgoingEventMessage

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingEventMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingNoticeMessage.html b/functions/_nostr_relay_core.createOutgoingNoticeMessage.html index 3cb9c972..e9c7ddc9 100644 --- a/functions/_nostr_relay_core.createOutgoingNoticeMessage.html +++ b/functions/_nostr_relay_core.createOutgoingNoticeMessage.html @@ -1,4 +1,4 @@ createOutgoingNoticeMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingNoticeMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/functions/_nostr_relay_core.createOutgoingOkMessage.html b/functions/_nostr_relay_core.createOutgoingOkMessage.html index 6383cb70..38fbf420 100644 --- a/functions/_nostr_relay_core.createOutgoingOkMessage.html +++ b/functions/_nostr_relay_core.createOutgoingOkMessage.html @@ -3,4 +3,4 @@

      Parameters

      Returns OutgoingOkMessage

      Generated using TypeDoc

      \ No newline at end of file +

      Returns OutgoingOkMessage

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.AfterEventBroadcast.html b/interfaces/_nostr_relay_common.AfterEventBroadcast.html index cfe95c5e..38786a8d 100644 --- a/interfaces/_nostr_relay_common.AfterEventBroadcast.html +++ b/interfaces/_nostr_relay_common.AfterEventBroadcast.html @@ -1,2 +1,2 @@ -AfterEventBroadcast | nostr-relay
      interface AfterEventBroadcast {
          afterEventBroadcast(ctx, event): void | Promise<void>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file +AfterEventBroadcast | nostr-relay
      interface AfterEventBroadcast {
          afterEventBroadcast(ctx, event): void | Promise<void>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.AfterEventHandle.html b/interfaces/_nostr_relay_common.AfterEventHandle.html index d8d04e1d..4f9c9e71 100644 --- a/interfaces/_nostr_relay_common.AfterEventHandle.html +++ b/interfaces/_nostr_relay_common.AfterEventHandle.html @@ -1,2 +1,2 @@ -AfterEventHandle | nostr-relay
      interface AfterEventHandle {
          afterEventHandle(ctx, event, handleResult): void | Promise<void>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file +AfterEventHandle | nostr-relay
      interface AfterEventHandle {
          afterEventHandle(ctx, event, handleResult): void | Promise<void>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.BeforeEventBroadcast.html b/interfaces/_nostr_relay_common.BeforeEventBroadcast.html index 2f513803..132b3b3a 100644 --- a/interfaces/_nostr_relay_common.BeforeEventBroadcast.html +++ b/interfaces/_nostr_relay_common.BeforeEventBroadcast.html @@ -1,2 +1,2 @@ -BeforeEventBroadcast | nostr-relay
      interface BeforeEventBroadcast {
          beforeEventBroadcast(ctx, event): BeforeHookResult<{}> | Promise<BeforeHookResult<{}>>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file +BeforeEventBroadcast | nostr-relay
      interface BeforeEventBroadcast {
          beforeEventBroadcast(ctx, event): BeforeHookResult<{}> | Promise<BeforeHookResult<{}>>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.BeforeEventHandle.html b/interfaces/_nostr_relay_common.BeforeEventHandle.html index c29bf6fe..580cea5c 100644 --- a/interfaces/_nostr_relay_common.BeforeEventHandle.html +++ b/interfaces/_nostr_relay_common.BeforeEventHandle.html @@ -1,2 +1,2 @@ -BeforeEventHandle | nostr-relay
      interface BeforeEventHandle {
          beforeEventHandle(ctx, event): BeforeEventHandleResult | Promise<BeforeEventHandleResult>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file +BeforeEventHandle | nostr-relay
      interface BeforeEventHandle {
          beforeEventHandle(ctx, event): BeforeEventHandleResult | Promise<BeforeEventHandleResult>;
      }

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.Client.html b/interfaces/_nostr_relay_common.Client.html index 53ea1e1e..126a7995 100644 --- a/interfaces/_nostr_relay_common.Client.html +++ b/interfaces/_nostr_relay_common.Client.html @@ -1,4 +1,4 @@ Client | nostr-relay

      Client interface. Usually a WebSocket.

      -
      interface Client {
          readyState: ClientReadyState;
          send(data, cb?): void;
      }

      Properties

      interface Client {
          readyState: ClientReadyState;
          send(data, cb?): void;
      }

      Properties

      Methods

      Properties

      readyState: ClientReadyState

      Methods

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      readyState: ClientReadyState

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.Event.html b/interfaces/_nostr_relay_common.Event.html index 19528258..9f405ed0 100644 --- a/interfaces/_nostr_relay_common.Event.html +++ b/interfaces/_nostr_relay_common.Event.html @@ -1,8 +1,8 @@ -Event | nostr-relay
      interface Event {
          content: string;
          created_at: number;
          id: string;
          kind: number;
          pubkey: string;
          sig: string;
          tags: Tag[];
      }

      Properties

      content +Event | nostr-relay
      interface Event {
          content: string;
          created_at: number;
          id: string;
          kind: number;
          pubkey: string;
          sig: string;
          tags: Tag[];
      }

      Properties

      content: string
      created_at: number
      id: string
      kind: number
      pubkey: string
      sig: string
      tags: Tag[]

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      content: string
      created_at: number
      id: string
      kind: number
      pubkey: string
      sig: string
      tags: Tag[]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.EventRepositoryUpsertResult.html b/interfaces/_nostr_relay_common.EventRepositoryUpsertResult.html index 9f0df762..018708e2 100644 --- a/interfaces/_nostr_relay_common.EventRepositoryUpsertResult.html +++ b/interfaces/_nostr_relay_common.EventRepositoryUpsertResult.html @@ -1,5 +1,5 @@ EventRepositoryUpsertResult | nostr-relay

      The result of upsert method.

      -
      interface EventRepositoryUpsertResult {
          isDuplicate: boolean;
      }

      Properties

      interface EventRepositoryUpsertResult {
          isDuplicate: boolean;
      }

      Properties

      Properties

      isDuplicate: boolean

      Indicates whether the event is a duplicate event. If it's true, the event will not be broadcasted. Otherwise, the event will be broadcasted.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.Filter.html b/interfaces/_nostr_relay_common.Filter.html index ec3befb9..076c9282 100644 --- a/interfaces/_nostr_relay_common.Filter.html +++ b/interfaces/_nostr_relay_common.Filter.html @@ -1,4 +1,4 @@ -Filter | nostr-relay
      interface Filter {
          #A?: string[];
          #B?: string[];
          #C?: string[];
          #D?: string[];
          #E?: string[];
          #F?: string[];
          #G?: string[];
          #H?: string[];
          #I?: string[];
          #J?: string[];
          #K?: string[];
          #L?: string[];
          #M?: string[];
          #N?: string[];
          #O?: string[];
          #P?: string[];
          #Q?: string[];
          #R?: string[];
          #S?: string[];
          #T?: string[];
          #U?: string[];
          #V?: string[];
          #W?: string[];
          #X?: string[];
          #Y?: string[];
          #Z?: string[];
          #a?: string[];
          #b?: string[];
          #c?: string[];
          #d?: string[];
          #e?: string[];
          #f?: string[];
          #g?: string[];
          #h?: string[];
          #i?: string[];
          #j?: string[];
          #k?: string[];
          #l?: string[];
          #m?: string[];
          #n?: string[];
          #o?: string[];
          #p?: string[];
          #q?: string[];
          #r?: string[];
          #s?: string[];
          #t?: string[];
          #u?: string[];
          #v?: string[];
          #w?: string[];
          #x?: string[];
          #y?: string[];
          #z?: string[];
          authors?: string[];
          ids?: string[];
          kinds?: number[];
          limit?: number;
          search?: string;
          since?: number;
          until?: number;
      }

      Properties

      #A? +Filter | nostr-relay
      interface Filter {
          #A?: string[];
          #B?: string[];
          #C?: string[];
          #D?: string[];
          #E?: string[];
          #F?: string[];
          #G?: string[];
          #H?: string[];
          #I?: string[];
          #J?: string[];
          #K?: string[];
          #L?: string[];
          #M?: string[];
          #N?: string[];
          #O?: string[];
          #P?: string[];
          #Q?: string[];
          #R?: string[];
          #S?: string[];
          #T?: string[];
          #U?: string[];
          #V?: string[];
          #W?: string[];
          #X?: string[];
          #Y?: string[];
          #Z?: string[];
          #a?: string[];
          #b?: string[];
          #c?: string[];
          #d?: string[];
          #e?: string[];
          #f?: string[];
          #g?: string[];
          #h?: string[];
          #i?: string[];
          #j?: string[];
          #k?: string[];
          #l?: string[];
          #m?: string[];
          #n?: string[];
          #o?: string[];
          #p?: string[];
          #q?: string[];
          #r?: string[];
          #s?: string[];
          #t?: string[];
          #u?: string[];
          #v?: string[];
          #w?: string[];
          #x?: string[];
          #y?: string[];
          #z?: string[];
          authors?: string[];
          ids?: string[];
          kinds?: number[];
          limit?: number;
          search?: string;
          since?: number;
          until?: number;
      }

      Properties

      #A? #B? #C? #D? @@ -57,4 +57,4 @@ search? since? until? -

      Properties

      #A?: string[]
      #B?: string[]
      #C?: string[]
      #D?: string[]
      #E?: string[]
      #F?: string[]
      #G?: string[]
      #H?: string[]
      #I?: string[]
      #J?: string[]
      #K?: string[]
      #L?: string[]
      #M?: string[]
      #N?: string[]
      #O?: string[]
      #P?: string[]
      #Q?: string[]
      #R?: string[]
      #S?: string[]
      #T?: string[]
      #U?: string[]
      #V?: string[]
      #W?: string[]
      #X?: string[]
      #Y?: string[]
      #Z?: string[]
      #a?: string[]
      #b?: string[]
      #c?: string[]
      #d?: string[]
      #e?: string[]
      #f?: string[]
      #g?: string[]
      #h?: string[]
      #i?: string[]
      #j?: string[]
      #k?: string[]
      #l?: string[]
      #m?: string[]
      #n?: string[]
      #o?: string[]
      #p?: string[]
      #q?: string[]
      #r?: string[]
      #s?: string[]
      #t?: string[]
      #u?: string[]
      #v?: string[]
      #w?: string[]
      #x?: string[]
      #y?: string[]
      #z?: string[]
      authors?: string[]
      ids?: string[]
      kinds?: number[]
      limit?: number
      search?: string
      since?: number
      until?: number

      Generated using TypeDoc

      \ No newline at end of file +

      Properties

      #A?: string[]
      #B?: string[]
      #C?: string[]
      #D?: string[]
      #E?: string[]
      #F?: string[]
      #G?: string[]
      #H?: string[]
      #I?: string[]
      #J?: string[]
      #K?: string[]
      #L?: string[]
      #M?: string[]
      #N?: string[]
      #O?: string[]
      #P?: string[]
      #Q?: string[]
      #R?: string[]
      #S?: string[]
      #T?: string[]
      #U?: string[]
      #V?: string[]
      #W?: string[]
      #X?: string[]
      #Y?: string[]
      #Z?: string[]
      #a?: string[]
      #b?: string[]
      #c?: string[]
      #d?: string[]
      #e?: string[]
      #f?: string[]
      #g?: string[]
      #h?: string[]
      #i?: string[]
      #j?: string[]
      #k?: string[]
      #l?: string[]
      #m?: string[]
      #n?: string[]
      #o?: string[]
      #p?: string[]
      #q?: string[]
      #r?: string[]
      #s?: string[]
      #t?: string[]
      #u?: string[]
      #v?: string[]
      #w?: string[]
      #x?: string[]
      #y?: string[]
      #z?: string[]
      authors?: string[]
      ids?: string[]
      kinds?: number[]
      limit?: number
      search?: string
      since?: number
      until?: number

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/_nostr_relay_common.Logger.html b/interfaces/_nostr_relay_common.Logger.html index 9c95c592..dc940fe7 100644 --- a/interfaces/_nostr_relay_common.Logger.html +++ b/interfaces/_nostr_relay_common.Logger.html @@ -1,6 +1,6 @@ -Logger | nostr-relay
      interface Logger {
          debug(message, ...args): void;
          error(message, ...args): void;
          info(message, ...args): void;
          setLogLevel(level): void;
          warn(message, ...args): void;
      }

      Implemented by

      Methods

      debug +Logger | nostr-relay
      interface Logger {
          debug(message, ...args): void;
          error(message, ...args): void;
          info(message, ...args): void;
          setLogLevel(level): void;
          warn(message, ...args): void;
      }

      Implemented by

      Methods

      Generated using TypeDoc

      \ No newline at end of file +

      Methods

      Generated using TypeDoc

      \ No newline at end of file diff --git a/modules/_nostr_relay_common.html b/modules/_nostr_relay_common.html index 0058d588..372a7528 100644 --- a/modules/_nostr_relay_common.html +++ b/modules/_nostr_relay_common.html @@ -1,4 +1,4 @@ -@nostr-relay/common - v0.0.15 | nostr-relay

      Module @nostr-relay/common - v0.0.15

      @nostr-relay/common

      +@nostr-relay/common - v0.0.16 | nostr-relay

      Module @nostr-relay/common - v0.0.16

      @nostr-relay/common

      Easily build your customized Nostr Relay.

      API

      Full API documentation can be found here

      diff --git a/modules/_nostr_relay_core.html b/modules/_nostr_relay_core.html index d849b737..31b6af3e 100644 --- a/modules/_nostr_relay_core.html +++ b/modules/_nostr_relay_core.html @@ -1,4 +1,4 @@ -@nostr-relay/core - v0.0.15 | nostr-relay

      Module @nostr-relay/core - v0.0.15

      @nostr-relay/core

      +@nostr-relay/core - v0.0.16 | nostr-relay

      Module @nostr-relay/core - v0.0.16

      @nostr-relay/core

      Easily build your customized Nostr Relay.

      API

      Full API documentation can be found here

      diff --git a/modules/_nostr_relay_event_repository_sqlite.html b/modules/_nostr_relay_event_repository_sqlite.html index b6a45ae5..a9f3de2e 100644 --- a/modules/_nostr_relay_event_repository_sqlite.html +++ b/modules/_nostr_relay_event_repository_sqlite.html @@ -1,4 +1,4 @@ -@nostr-relay/event-repository-sqlite - v0.0.15 | nostr-relay

      Module @nostr-relay/event-repository-sqlite - v0.0.15

      @nostr-relay/event-repository-sqlite

      +@nostr-relay/event-repository-sqlite - v0.0.16 | nostr-relay

      Module @nostr-relay/event-repository-sqlite - v0.0.16

      @nostr-relay/event-repository-sqlite

      Easily build your customized Nostr Relay.

      API

      Full API documentation can be found here

      diff --git a/modules/_nostr_relay_validator.html b/modules/_nostr_relay_validator.html index 1a9d8110..1f6f2650 100644 --- a/modules/_nostr_relay_validator.html +++ b/modules/_nostr_relay_validator.html @@ -1,4 +1,4 @@ -@nostr-relay/validator - v0.0.15 | nostr-relay

      Module @nostr-relay/validator - v0.0.15

      @nostr-relay/validator

      +@nostr-relay/validator - v0.0.16 | nostr-relay

      Module @nostr-relay/validator - v0.0.16

      @nostr-relay/validator

      Easily build your customized Nostr Relay.

      API

      Full API documentation can be found here

      diff --git a/types/_nostr_relay_common.BeforeEventHandleResult.html b/types/_nostr_relay_common.BeforeEventHandleResult.html index 0d250cf9..8a807ffa 100644 --- a/types/_nostr_relay_common.BeforeEventHandleResult.html +++ b/types/_nostr_relay_common.BeforeEventHandleResult.html @@ -1 +1 @@ -BeforeEventHandleResult | nostr-relay
      BeforeEventHandleResult: BeforeHookResult<{
          result: EventHandleResult;
      }>

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +BeforeEventHandleResult | nostr-relay
      BeforeEventHandleResult: BeforeHookResult<{
          result: EventHandleResult;
      }>

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.BeforeHookResult.html b/types/_nostr_relay_common.BeforeHookResult.html index 8d3b3522..f12520e6 100644 --- a/types/_nostr_relay_common.BeforeHookResult.html +++ b/types/_nostr_relay_common.BeforeHookResult.html @@ -1 +1 @@ -BeforeHookResult | nostr-relay
      BeforeHookResult<T>: {
          canContinue: true;
      } | {
          canContinue: false;
      } & T

      Type Parameters

      • T = {}

      Type declaration

      • canContinue: true

      Generated using TypeDoc

      \ No newline at end of file +BeforeHookResult | nostr-relay
      BeforeHookResult<T>: {
          canContinue: true;
      } | {
          canContinue: false;
      } & T

      Type Parameters

      • T = {}

      Type declaration

      • canContinue: true

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.ClientContextOptions.html b/types/_nostr_relay_common.ClientContextOptions.html index 212dd9b7..8e806054 100644 --- a/types/_nostr_relay_common.ClientContextOptions.html +++ b/types/_nostr_relay_common.ClientContextOptions.html @@ -1,3 +1,3 @@ ClientContextOptions | nostr-relay
      ClientContextOptions: {
          maxSubscriptionsPerClient?: number;
      }

      Client context options

      Type declaration

      • Optional maxSubscriptionsPerClient?: number

        Maximum number of subscriptions per client. Default: 20

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.ClientReadyState.html b/types/_nostr_relay_common.ClientReadyState.html index 09b35cab..4c7582d1 100644 --- a/types/_nostr_relay_common.ClientReadyState.html +++ b/types/_nostr_relay_common.ClientReadyState.html @@ -1 +1 @@ -ClientReadyState | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +ClientReadyState | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.EventHandleResult.html b/types/_nostr_relay_common.EventHandleResult.html index 0be8ef2f..6c475b73 100644 --- a/types/_nostr_relay_common.EventHandleResult.html +++ b/types/_nostr_relay_common.EventHandleResult.html @@ -1 +1 @@ -EventHandleResult | nostr-relay
      EventHandleResult: {
          message?: string;
          noReplyNeeded?: boolean;
          success: boolean;
      }

      Type declaration

      • Optional message?: string
      • Optional noReplyNeeded?: boolean
      • success: boolean

      Generated using TypeDoc

      \ No newline at end of file +EventHandleResult | nostr-relay
      EventHandleResult: {
          message?: string;
          noReplyNeeded?: boolean;
          success: boolean;
      }

      Type declaration

      • Optional message?: string
      • Optional noReplyNeeded?: boolean
      • success: boolean

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.EventId.html b/types/_nostr_relay_common.EventId.html index 8928ddb0..8e522608 100644 --- a/types/_nostr_relay_common.EventId.html +++ b/types/_nostr_relay_common.EventId.html @@ -1 +1 @@ -EventId | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +EventId | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.EventKind.html b/types/_nostr_relay_common.EventKind.html index 0b4a7c3c..25810785 100644 --- a/types/_nostr_relay_common.EventKind.html +++ b/types/_nostr_relay_common.EventKind.html @@ -1 +1 @@ -EventKind | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +EventKind | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.EventType.html b/types/_nostr_relay_common.EventType.html index ed3e7f88..c5048be0 100644 --- a/types/_nostr_relay_common.EventType.html +++ b/types/_nostr_relay_common.EventType.html @@ -1 +1 @@ -EventType | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +EventType | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.IncomingAuthMessage.html b/types/_nostr_relay_common.IncomingAuthMessage.html index 39459662..b3e8b41c 100644 --- a/types/_nostr_relay_common.IncomingAuthMessage.html +++ b/types/_nostr_relay_common.IncomingAuthMessage.html @@ -1 +1 @@ -IncomingAuthMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +IncomingAuthMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.IncomingCloseMessage.html b/types/_nostr_relay_common.IncomingCloseMessage.html index a9e85bbb..6a7104a9 100644 --- a/types/_nostr_relay_common.IncomingCloseMessage.html +++ b/types/_nostr_relay_common.IncomingCloseMessage.html @@ -1 +1 @@ -IncomingCloseMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +IncomingCloseMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.IncomingEventMessage.html b/types/_nostr_relay_common.IncomingEventMessage.html index c9047be7..e09aa750 100644 --- a/types/_nostr_relay_common.IncomingEventMessage.html +++ b/types/_nostr_relay_common.IncomingEventMessage.html @@ -1 +1 @@ -IncomingEventMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +IncomingEventMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.IncomingMessage.html b/types/_nostr_relay_common.IncomingMessage.html index a2a7ba21..14c4c6a9 100644 --- a/types/_nostr_relay_common.IncomingMessage.html +++ b/types/_nostr_relay_common.IncomingMessage.html @@ -1 +1 @@ -IncomingMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +IncomingMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.IncomingReqMessage.html b/types/_nostr_relay_common.IncomingReqMessage.html index 89037a15..0b413322 100644 --- a/types/_nostr_relay_common.IncomingReqMessage.html +++ b/types/_nostr_relay_common.IncomingReqMessage.html @@ -1 +1 @@ -IncomingReqMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +IncomingReqMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.LogLevel.html b/types/_nostr_relay_common.LogLevel.html index 6c46a002..a5169bff 100644 --- a/types/_nostr_relay_common.LogLevel.html +++ b/types/_nostr_relay_common.LogLevel.html @@ -1 +1 @@ -LogLevel | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +LogLevel | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.MessageType.html b/types/_nostr_relay_common.MessageType.html index 7f859587..21eee877 100644 --- a/types/_nostr_relay_common.MessageType.html +++ b/types/_nostr_relay_common.MessageType.html @@ -1 +1 @@ -MessageType | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +MessageType | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.NostrRelayPlugin.html b/types/_nostr_relay_common.NostrRelayPlugin.html index 72bdef9f..14fcc858 100644 --- a/types/_nostr_relay_common.NostrRelayPlugin.html +++ b/types/_nostr_relay_common.NostrRelayPlugin.html @@ -1 +1 @@ -NostrRelayPlugin | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +NostrRelayPlugin | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingAuthMessage.html b/types/_nostr_relay_common.OutgoingAuthMessage.html index 3549d185..8f5d4463 100644 --- a/types/_nostr_relay_common.OutgoingAuthMessage.html +++ b/types/_nostr_relay_common.OutgoingAuthMessage.html @@ -1 +1 @@ -OutgoingAuthMessage | nostr-relay
      OutgoingAuthMessage: [typeof AUTH, string]

      Generated using TypeDoc

      \ No newline at end of file +OutgoingAuthMessage | nostr-relay
      OutgoingAuthMessage: [typeof AUTH, string]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingClosedMessage.html b/types/_nostr_relay_common.OutgoingClosedMessage.html index b5e0bad6..df8c198d 100644 --- a/types/_nostr_relay_common.OutgoingClosedMessage.html +++ b/types/_nostr_relay_common.OutgoingClosedMessage.html @@ -1 +1 @@ -OutgoingClosedMessage | nostr-relay
      OutgoingClosedMessage: [typeof CLOSED, SubscriptionId, string]

      Generated using TypeDoc

      \ No newline at end of file +OutgoingClosedMessage | nostr-relay
      OutgoingClosedMessage: [typeof CLOSED, SubscriptionId, string]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingEoseMessage.html b/types/_nostr_relay_common.OutgoingEoseMessage.html index 19cff92a..c8fa053a 100644 --- a/types/_nostr_relay_common.OutgoingEoseMessage.html +++ b/types/_nostr_relay_common.OutgoingEoseMessage.html @@ -1 +1 @@ -OutgoingEoseMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +OutgoingEoseMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingEventMessage.html b/types/_nostr_relay_common.OutgoingEventMessage.html index 88b2da08..32a3ae75 100644 --- a/types/_nostr_relay_common.OutgoingEventMessage.html +++ b/types/_nostr_relay_common.OutgoingEventMessage.html @@ -1 +1 @@ -OutgoingEventMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +OutgoingEventMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingMessage.html b/types/_nostr_relay_common.OutgoingMessage.html index 0c4f1bfc..72763765 100644 --- a/types/_nostr_relay_common.OutgoingMessage.html +++ b/types/_nostr_relay_common.OutgoingMessage.html @@ -1 +1 @@ -OutgoingMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +OutgoingMessage | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingNoticeMessage.html b/types/_nostr_relay_common.OutgoingNoticeMessage.html index ecbc75e9..145f2e7f 100644 --- a/types/_nostr_relay_common.OutgoingNoticeMessage.html +++ b/types/_nostr_relay_common.OutgoingNoticeMessage.html @@ -1 +1 @@ -OutgoingNoticeMessage | nostr-relay
      OutgoingNoticeMessage: [typeof NOTICE, string]

      Generated using TypeDoc

      \ No newline at end of file +OutgoingNoticeMessage | nostr-relay
      OutgoingNoticeMessage: [typeof NOTICE, string]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.OutgoingOkMessage.html b/types/_nostr_relay_common.OutgoingOkMessage.html index c38b4a89..e9a9f51c 100644 --- a/types/_nostr_relay_common.OutgoingOkMessage.html +++ b/types/_nostr_relay_common.OutgoingOkMessage.html @@ -1 +1 @@ -OutgoingOkMessage | nostr-relay
      OutgoingOkMessage: [typeof OK, EventId, boolean, string]

      Generated using TypeDoc

      \ No newline at end of file +OutgoingOkMessage | nostr-relay
      OutgoingOkMessage: [typeof OK, EventId, boolean, string]

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.Pubkey.html b/types/_nostr_relay_common.Pubkey.html index d923c2a7..54d2fb2f 100644 --- a/types/_nostr_relay_common.Pubkey.html +++ b/types/_nostr_relay_common.Pubkey.html @@ -1 +1 @@ -Pubkey | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +Pubkey | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.Signature.html b/types/_nostr_relay_common.Signature.html index dcd24b51..4128b071 100644 --- a/types/_nostr_relay_common.Signature.html +++ b/types/_nostr_relay_common.Signature.html @@ -1 +1 @@ -Signature | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +Signature | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.SubscriptionId.html b/types/_nostr_relay_common.SubscriptionId.html index 0bcda8f9..f472776b 100644 --- a/types/_nostr_relay_common.SubscriptionId.html +++ b/types/_nostr_relay_common.SubscriptionId.html @@ -1 +1 @@ -SubscriptionId | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +SubscriptionId | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.Tag.html b/types/_nostr_relay_common.Tag.html index fb72fde7..5c240b8e 100644 --- a/types/_nostr_relay_common.Tag.html +++ b/types/_nostr_relay_common.Tag.html @@ -1 +1 @@ -Tag | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +Tag | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_common.TagName.html b/types/_nostr_relay_common.TagName.html index dc51b605..0aa84126 100644 --- a/types/_nostr_relay_common.TagName.html +++ b/types/_nostr_relay_common.TagName.html @@ -1 +1 @@ -TagName | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file +TagName | nostr-relay

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.HandleAuthMessageResult.html b/types/_nostr_relay_core.HandleAuthMessageResult.html index 3cd3d780..fd743d53 100644 --- a/types/_nostr_relay_core.HandleAuthMessageResult.html +++ b/types/_nostr_relay_core.HandleAuthMessageResult.html @@ -1,3 +1,3 @@ HandleAuthMessageResult | nostr-relay

      Type alias HandleAuthMessageResult

      HandleAuthMessageResult: {
          success: boolean;
      }

      Result of handling AUTH message

      Type declaration

      • success: boolean

        Whether the authentication was successful

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.HandleCloseMessageResult.html b/types/_nostr_relay_core.HandleCloseMessageResult.html index 8a21c842..0fce65e5 100644 --- a/types/_nostr_relay_core.HandleCloseMessageResult.html +++ b/types/_nostr_relay_core.HandleCloseMessageResult.html @@ -1,3 +1,3 @@ HandleCloseMessageResult | nostr-relay

      Type alias HandleCloseMessageResult

      HandleCloseMessageResult: {
          success: boolean;
      }

      Result of handling CLOSE message

      Type declaration

      • success: boolean

        Whether the subscription was successfully closed

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.HandleEventMessageResult.html b/types/_nostr_relay_core.HandleEventMessageResult.html index 4e93e221..70e8499d 100644 --- a/types/_nostr_relay_core.HandleEventMessageResult.html +++ b/types/_nostr_relay_core.HandleEventMessageResult.html @@ -1,4 +1,4 @@ HandleEventMessageResult | nostr-relay

      Type alias HandleEventMessageResult

      HandleEventMessageResult: {
          message?: string;
          success: boolean;
      }

      Result of handling EVENT message

      Type declaration

      • Optional message?: string

        Message to send to the client

      • success: boolean

        Whether the event was successfully handled

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.HandleMessageResult.html b/types/_nostr_relay_core.HandleMessageResult.html index 3101b013..7033fb10 100644 --- a/types/_nostr_relay_core.HandleMessageResult.html +++ b/types/_nostr_relay_core.HandleMessageResult.html @@ -1,2 +1,2 @@ HandleMessageResult | nostr-relay
      HandleMessageResult: {
          messageType: typeof MessageType.REQ;
      } & HandleReqMessageResult | {
          messageType: typeof MessageType.EVENT;
      } & HandleEventMessageResult | {
          messageType: typeof MessageType.CLOSE;
      } & HandleCloseMessageResult | {
          messageType: typeof MessageType.AUTH;
      } & HandleAuthMessageResult | void

      Result of handling an incoming message

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.HandleReqMessageResult.html b/types/_nostr_relay_core.HandleReqMessageResult.html index 09690381..74de7423 100644 --- a/types/_nostr_relay_core.HandleReqMessageResult.html +++ b/types/_nostr_relay_core.HandleReqMessageResult.html @@ -1,3 +1,3 @@ HandleReqMessageResult | nostr-relay
      HandleReqMessageResult: {
          events: Event[];
      }

      Result of handling REQ message

      Type declaration

      • events: Event[]

        The events that match the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_core.NostrRelayOptions.html b/types/_nostr_relay_core.NostrRelayOptions.html index 67e5f931..44132c40 100644 --- a/types/_nostr_relay_core.NostrRelayOptions.html +++ b/types/_nostr_relay_core.NostrRelayOptions.html @@ -7,4 +7,4 @@
    • Optional logger?: Logger

      Logger to use. Default: ConsoleLoggerService

    • Optional maxSubscriptionsPerClient?: number

      Maximum number of subscriptions per client. Default: 20

    • Optional minPowDifficulty?: number

      Allowed minimum PoW difficulty for events. Default: 0

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_validator.RawData.html b/types/_nostr_relay_validator.RawData.html index af099fff..15a8628f 100644 --- a/types/_nostr_relay_validator.RawData.html +++ b/types/_nostr_relay_validator.RawData.html @@ -1 +1 @@ -RawData | nostr-relay
      RawData: Buffer | ArrayBuffer | Buffer[] | string | object

      Generated using TypeDoc

      \ No newline at end of file +RawData | nostr-relay
      RawData: Buffer | ArrayBuffer | Buffer[] | string | object

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_validator.RequiredValidatorOptions.html b/types/_nostr_relay_validator.RequiredValidatorOptions.html index de097b4f..e08dfd3a 100644 --- a/types/_nostr_relay_validator.RequiredValidatorOptions.html +++ b/types/_nostr_relay_validator.RequiredValidatorOptions.html @@ -1 +1 @@ -RequiredValidatorOptions | nostr-relay
      RequiredValidatorOptions: Required<ValidatorOptions>

      Generated using TypeDoc

      \ No newline at end of file +RequiredValidatorOptions | nostr-relay
      RequiredValidatorOptions: Required<ValidatorOptions>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/types/_nostr_relay_validator.ValidatorOptions.html b/types/_nostr_relay_validator.ValidatorOptions.html index de8b8d73..6f5e7745 100644 --- a/types/_nostr_relay_validator.ValidatorOptions.html +++ b/types/_nostr_relay_validator.ValidatorOptions.html @@ -8,4 +8,4 @@
    • Optional maxNumberOfTags?: number

      maximum number of tags. Default: 2000

    • Optional maxSubscriptionIdLength?: number

      maximum length of subscription id. Default: 128

    • Optional maxTagValueLength?: number

      maximum length of tag value. Default: 1024

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.ClientReadyState-1.html b/variables/_nostr_relay_common.ClientReadyState-1.html index ff30f558..5d6edbf9 100644 --- a/variables/_nostr_relay_common.ClientReadyState-1.html +++ b/variables/_nostr_relay_common.ClientReadyState-1.html @@ -1,2 +1,2 @@ ClientReadyState | nostr-relay

      Variable ClientReadyStateConst

      ClientReadyState: {
          CLOSED: 3;
          CLOSING: 2;
          CONNECTING: 0;
          OPEN: 1;
      } = ...

      Same as WebSocket readyState

      -

      Type declaration

      • Readonly CLOSED: 3
      • Readonly CLOSING: 2
      • Readonly CONNECTING: 0
      • Readonly OPEN: 1

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.EventKind-1.html b/variables/_nostr_relay_common.EventKind-1.html index d557c8d5..54731456 100644 --- a/variables/_nostr_relay_common.EventKind-1.html +++ b/variables/_nostr_relay_common.EventKind-1.html @@ -1,2 +1,2 @@ EventKind | nostr-relay
      EventKind: {
          AUTHENTICATION: number;
          CHANNEL_CREATION: number;
          CHANNEL_HIDE_MESSAGE: number;
          CHANNEL_MESSAGE: number;
          CHANNEL_METADATA: number;
          CHANNEL_MUTE_USER: number;
          CHANNEL_RESERVE_FIRST: number;
          CHANNEL_RESERVE_LAST: number;
          CONTACT_LIST: number;
          DELETION: number;
          ENCRYPTED_DIRECT_MESSAGE: number;
          EPHEMERAL_FIRST: number;
          EPHEMERAL_LAST: number;
          LONG_FORM_CONTENT: number;
          PARAMETERIZED_REPLACEABLE_FIRST: number;
          PARAMETERIZED_REPLACEABLE_LAST: number;
          RECOMMEND_SERVER: number;
          REGULAR_FIRST: number;
          REGULAR_LAST: number;
          REPLACEABLE_FIRST: number;
          REPLACEABLE_LAST: number;
          SET_METADATA: number;
          TEXT_NOTE: number;
      } = ...

      Some special event kinds

      -

      Type declaration

      • AUTHENTICATION: number
      • CHANNEL_CREATION: number
      • CHANNEL_HIDE_MESSAGE: number
      • CHANNEL_MESSAGE: number
      • CHANNEL_METADATA: number
      • CHANNEL_MUTE_USER: number
      • CHANNEL_RESERVE_FIRST: number
      • CHANNEL_RESERVE_LAST: number
      • CONTACT_LIST: number
      • DELETION: number
      • ENCRYPTED_DIRECT_MESSAGE: number
      • EPHEMERAL_FIRST: number
      • EPHEMERAL_LAST: number
      • LONG_FORM_CONTENT: number
      • PARAMETERIZED_REPLACEABLE_FIRST: number
      • PARAMETERIZED_REPLACEABLE_LAST: number
      • RECOMMEND_SERVER: number
      • REGULAR_FIRST: number
      • REGULAR_LAST: number
      • REPLACEABLE_FIRST: number
      • REPLACEABLE_LAST: number
      • SET_METADATA: number
      • TEXT_NOTE: number

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.EventType-1.html b/variables/_nostr_relay_common.EventType-1.html index 235711bf..800d570c 100644 --- a/variables/_nostr_relay_common.EventType-1.html +++ b/variables/_nostr_relay_common.EventType-1.html @@ -2,4 +2,4 @@
    • Readonly PARAMETERIZED_REPLACEABLE: "PARAMETERIZED_REPLACEABLE"

      Parameterized replaceable event

    • Readonly REGULAR: "REGULAR"

      Regular event

    • Readonly REPLACEABLE: "REPLACEABLE"

      Replaceable event

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.LogLevel-1.html b/variables/_nostr_relay_common.LogLevel-1.html index d8723387..40364c53 100644 --- a/variables/_nostr_relay_common.LogLevel-1.html +++ b/variables/_nostr_relay_common.LogLevel-1.html @@ -1 +1 @@ -LogLevel | nostr-relay
      LogLevel: {
          DEBUG: 0;
          ERROR: 3;
          INFO: 1;
          WARN: 2;
      } = ...

      Type declaration

      • Readonly DEBUG: 0
      • Readonly ERROR: 3
      • Readonly INFO: 1
      • Readonly WARN: 2

      Generated using TypeDoc

      \ No newline at end of file +LogLevel | nostr-relay
      LogLevel: {
          DEBUG: 0;
          ERROR: 3;
          INFO: 1;
          WARN: 2;
      } = ...

      Type declaration

      • Readonly DEBUG: 0
      • Readonly ERROR: 3
      • Readonly INFO: 1
      • Readonly WARN: 2

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.MessageType-1.html b/variables/_nostr_relay_common.MessageType-1.html index d6b56251..c91f00c4 100644 --- a/variables/_nostr_relay_common.MessageType-1.html +++ b/variables/_nostr_relay_common.MessageType-1.html @@ -1 +1 @@ -MessageType | nostr-relay
      MessageType: {
          AUTH: "AUTH";
          CLOSE: "CLOSE";
          CLOSED: "CLOSED";
          EOSE: "EOSE";
          EVENT: "EVENT";
          NOTICE: "NOTICE";
          OK: "OK";
          REQ: "REQ";
      } = ...

      Type declaration

      • Readonly AUTH: "AUTH"
      • Readonly CLOSE: "CLOSE"
      • Readonly CLOSED: "CLOSED"
      • Readonly EOSE: "EOSE"
      • Readonly EVENT: "EVENT"
      • Readonly NOTICE: "NOTICE"
      • Readonly OK: "OK"
      • Readonly REQ: "REQ"

      Generated using TypeDoc

      \ No newline at end of file +MessageType | nostr-relay
      MessageType: {
          AUTH: "AUTH";
          CLOSE: "CLOSE";
          CLOSED: "CLOSED";
          EOSE: "EOSE";
          EVENT: "EVENT";
          NOTICE: "NOTICE";
          OK: "OK";
          REQ: "REQ";
      } = ...

      Type declaration

      • Readonly AUTH: "AUTH"
      • Readonly CLOSE: "CLOSE"
      • Readonly CLOSED: "CLOSED"
      • Readonly EOSE: "EOSE"
      • Readonly EVENT: "EVENT"
      • Readonly NOTICE: "NOTICE"
      • Readonly OK: "OK"
      • Readonly REQ: "REQ"

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/_nostr_relay_common.TagName-1.html b/variables/_nostr_relay_common.TagName-1.html index d9da57a6..9d2fc27b 100644 --- a/variables/_nostr_relay_common.TagName-1.html +++ b/variables/_nostr_relay_common.TagName-1.html @@ -1 +1 @@ -TagName | nostr-relay
      TagName: {
          CHALLENGE: "challenge";
          D: "d";
          DELEGATION: "delegation";
          EVENT: "e";
          EVENT_COORDINATES: "a";
          EXPIRATION: "expiration";
          NONCE: "nonce";
          PUBKEY: "p";
          RELAY: "relay";
      } = ...

      Type declaration

      • Readonly CHALLENGE: "challenge"
      • Readonly D: "d"
      • Readonly DELEGATION: "delegation"
      • Readonly EVENT: "e"
      • Readonly EVENT_COORDINATES: "a"
      • Readonly EXPIRATION: "expiration"
      • Readonly NONCE: "nonce"
      • Readonly PUBKEY: "p"
      • Readonly RELAY: "relay"

      Generated using TypeDoc

      \ No newline at end of file +TagName | nostr-relay
      TagName: {
          CHALLENGE: "challenge";
          D: "d";
          DELEGATION: "delegation";
          EVENT: "e";
          EVENT_COORDINATES: "a";
          EXPIRATION: "expiration";
          NONCE: "nonce";
          PUBKEY: "p";
          RELAY: "relay";
      } = ...

      Type declaration

      • Readonly CHALLENGE: "challenge"
      • Readonly D: "d"
      • Readonly DELEGATION: "delegation"
      • Readonly EVENT: "e"
      • Readonly EVENT_COORDINATES: "a"
      • Readonly EXPIRATION: "expiration"
      • Readonly NONCE: "nonce"
      • Readonly PUBKEY: "p"
      • Readonly RELAY: "relay"

      Generated using TypeDoc

      \ No newline at end of file