Interface NDKConstructorParams

Hierarchy

  • NDKConstructorParams

Properties

autoConnectUserRelays? autoFetchUserMutelist? blacklistRelayUrls? cacheAdapter? clientName? clientNip89? debug? devWriteRelayUrls? enableOutboxModel? explicitRelayUrls? mutedIds? outboxRelayUrls? relayAuthDefaultPolicy? signer?

Properties

Optional autoConnectUserRelays

autoConnectUserRelays?: boolean

Auto-connect to main user's relays. The "main" user is determined by the presence of a signer. Upon connection to the explicit relays, the user's relays will be fetched and connected to if this is set to true.

Default

true

Optional autoFetchUserMutelist

autoFetchUserMutelist?: boolean

Automatically fetch user's mutelist

Default

true

Optional blacklistRelayUrls

blacklistRelayUrls?: string[]

Relays we should never connect to

Optional cacheAdapter

cacheAdapter?: NDKCacheAdapter

Cache adapter to use for caching events

Optional clientName

clientName?: string

Client name to add to events' tag

Optional clientNip89

clientNip89?: string

Client nip89 to add to events' tag

Optional debug

debug?: Debugger

Debug instance to use

Optional devWriteRelayUrls

devWriteRelayUrls?: string[]

When this is set, we always write only to this relays.

Optional enableOutboxModel

enableOutboxModel?: boolean

Enable outbox model (defaults to false)

Optional explicitRelayUrls

explicitRelayUrls?: string[]

Relays we should explicitly connect to

Optional mutedIds

mutedIds?: Map<string, string>

Muted pubkeys and eventIds

Optional outboxRelayUrls

outboxRelayUrls?: string[]

Outbox relay URLs.

Optional relayAuthDefaultPolicy

relayAuthDefaultPolicy?: NDKAuthPolicy

Default relay-auth policy

Optional signer

signer?: NDKSigner

Signer to use for signing events by default

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc