Welshman

Appearance

Welshman Docs / @welshman/net

@welshman/net ​

Enumerations ​

AdapterEvent ​

Defined in: packages/net/src/adapter.ts:18

Enumeration Members ​

Receive ​

Receive: "receive"

Defined in: packages/net/src/adapter.ts:19

AuthStateEvent ​

Defined in: packages/net/src/auth.ts:24

Enumeration Members ​

Status ​

Status: "status"

Defined in: packages/net/src/auth.ts:25

AuthStatus ​

Defined in: packages/net/src/auth.ts:9

Enumeration Members ​

DeniedSignature ​

DeniedSignature: "denied_signature"

Defined in: packages/net/src/auth.ts:13

Forbidden ​

Forbidden: "forbidden"

Defined in: packages/net/src/auth.ts:15

None ​

None: "none"

Defined in: packages/net/src/auth.ts:10

Ok ​

Ok: "ok"

Defined in: packages/net/src/auth.ts:16

PendingResponse ​

PendingResponse: "pending_response"

Defined in: packages/net/src/auth.ts:14

PendingSignature ​

PendingSignature: "pending_signature"

Defined in: packages/net/src/auth.ts:12

Requested ​

Requested: "requested"

Defined in: packages/net/src/auth.ts:11

ClientMessageType ​

Defined in: packages/net/src/message.ts:92

Enumeration Members ​

Auth ​

Auth: "AUTH"

Defined in: packages/net/src/message.ts:93

Close ​

Close: "CLOSE"

Defined in: packages/net/src/message.ts:94

Event ​

Event: "EVENT"

Defined in: packages/net/src/message.ts:95

NegClose ​

NegClose: "NEG-CLOSE"

Defined in: packages/net/src/message.ts:96

NegOpen ​

NegOpen: "NEG-OPEN"

Defined in: packages/net/src/message.ts:97

Req ​

Req: "REQ"

Defined in: packages/net/src/message.ts:98

DifferenceEvent ​

Defined in: packages/net/src/diff.ts:16

Enumeration Members ​

Close ​

Close: "close"

Defined in: packages/net/src/diff.ts:19

Error ​

Error: "error"

Defined in: packages/net/src/diff.ts:18

Message ​

Message: "message"

Defined in: packages/net/src/diff.ts:17

PublishStatus ​

Defined in: packages/net/src/publish.ts:6

Enumeration Members ​

Aborted ​

Aborted: "aborted"

Defined in: packages/net/src/publish.ts:12

Failure ​

Failure: "failure"

Defined in: packages/net/src/publish.ts:10

Pending ​

Pending: "pending"

Defined in: packages/net/src/publish.ts:8

Sending ​

Sending: "sending"

Defined in: packages/net/src/publish.ts:7

Success ​

Success: "success"

Defined in: packages/net/src/publish.ts:9

Timeout ​

Timeout: "timeout"

Defined in: packages/net/src/publish.ts:11

RelayMessageType ​

Defined in: packages/net/src/message.ts:5

Enumeration Members ​

Auth ​

Auth: "AUTH"

Defined in: packages/net/src/message.ts:7

Closed ​

Closed: "CLOSED"

Defined in: packages/net/src/message.ts:8

Eose ​

Eose: "EOSE"

Defined in: packages/net/src/message.ts:9

Event ​

Event: "EVENT"

Defined in: packages/net/src/message.ts:10

NegErr ​

NegErr: "NEG-ERR"

Defined in: packages/net/src/message.ts:12

NegMsg ​

NegMsg: "NEG-MSG"

Defined in: packages/net/src/message.ts:11

Notice ​

Notice: "NOTICE"

Defined in: packages/net/src/message.ts:6

Ok ​

Ok: "OK"

Defined in: packages/net/src/message.ts:13

RelayReasonPrefix ​

Defined in: packages/net/src/message.ts:66

Enumeration Members ​

AuthRequired ​

AuthRequired: "auth-required"

Defined in: packages/net/src/message.ts:67

Blocked ​

Blocked: "blocked"

Defined in: packages/net/src/message.ts:68

Invalid ​

Invalid: "invalid"

Defined in: packages/net/src/message.ts:69

Mute ​

Mute: "mute"

Defined in: packages/net/src/message.ts:70

Pow ​

Pow: "pow"

Defined in: packages/net/src/message.ts:71

Restricted ​

Restricted: "restricted"

Defined in: packages/net/src/message.ts:72

Unsupported ​

Unsupported: "unsupported"

Defined in: packages/net/src/message.ts:73

SocketEvent ​

Defined in: packages/net/src/socket.ts:16

Enumeration Members ​

Error ​

Error: "error"

Defined in: packages/net/src/socket.ts:17

Receive ​

Receive: "receive"

Defined in: packages/net/src/socket.ts:21

Receiving ​

Receiving: "receiving"

Defined in: packages/net/src/socket.ts:22

Send ​

Send: "send"

Defined in: packages/net/src/socket.ts:19

Sending ​

Sending: "sending"

Defined in: packages/net/src/socket.ts:20

Status ​

Status: "status"

Defined in: packages/net/src/socket.ts:18

SocketStatus ​

Defined in: packages/net/src/socket.ts:8

Enumeration Members ​

Closed ​

Closed: "closed"

Defined in: packages/net/src/socket.ts:12

Closing ​

Closing: "closing"

Defined in: packages/net/src/socket.ts:11

Error ​

Error: "error"

Defined in: packages/net/src/socket.ts:13

Open ​

Open: "open"

Defined in: packages/net/src/socket.ts:9

Opening ​

Opening: "opening"

Defined in: packages/net/src/socket.ts:10

Classes ​

Type Aliases ​

AdapterContext ​

AdapterContext = Partial<NetContext>

Defined in: packages/net/src/adapter.ts:151

AdapterEvents ​

AdapterEvents = object

Defined in: packages/net/src/adapter.ts:22

Properties ​

receive() ​

receive: (message, url) => void

Defined in: packages/net/src/adapter.ts:23

Parameters ​
message ​

RelayMessage

url ​

string

Returns ​

void

AdapterFactory() ​

AdapterFactory = (url, context) => AbstractAdapter | undefined

Defined in: packages/net/src/context.ts:5

Parameters ​

url ​

string

context ​

NetContext

Returns ​

AbstractAdapter | undefined

AuthResult ​

AuthResult = object

Defined in: packages/net/src/auth.ts:19

Properties ​

ok ​

ok: boolean

Defined in: packages/net/src/auth.ts:20

reason? ​

optional reason: string

Defined in: packages/net/src/auth.ts:21

AuthStateEvents ​

AuthStateEvents = object

Defined in: packages/net/src/auth.ts:28

Properties ​

status() ​

status: (status) => void

Defined in: packages/net/src/auth.ts:29

Parameters ​
status ​

AuthStatus

Returns ​

void

BaseRequestOptions ​

BaseRequestOptions = object

Defined in: packages/net/src/request.ts:41

Properties ​

autoClose? ​

optional autoClose: boolean

Defined in: packages/net/src/request.ts:46

context? ​

optional context: AdapterContext

Defined in: packages/net/src/request.ts:45

isEventValid? ​

optional isEventValid: IsEventValid

Defined in: packages/net/src/request.ts:48

onClose()? ​

optional onClose: () => void

Defined in: packages/net/src/request.ts:57

Returns ​

void

onClosed()? ​

optional onClosed: (message, url) => void

Defined in: packages/net/src/request.ts:56

Parameters ​
message ​

string

url ​

string

Returns ​

void

onDeleted()? ​

optional onDeleted: (event, url) => void

Defined in: packages/net/src/request.ts:50

Parameters ​
event ​

unknown

url ​

string

Returns ​

void

onDisconnect()? ​

optional onDisconnect: (url) => void

Defined in: packages/net/src/request.ts:54

Parameters ​
url ​

string

Returns ​

void

onDuplicate()? ​

optional onDuplicate: (event, url) => void

Defined in: packages/net/src/request.ts:53

Parameters ​
event ​

TrustedEvent

url ​

string

Returns ​

void

onEose()? ​

optional onEose: (url) => void

Defined in: packages/net/src/request.ts:55

Parameters ​
url ​

string

Returns ​

void

onEvent()? ​

optional onEvent: (event, url) => void

Defined in: packages/net/src/request.ts:49

Parameters ​
event ​

TrustedEvent

url ​

string

Returns ​

void

onFiltered()? ​

optional onFiltered: (event, url) => void

Defined in: packages/net/src/request.ts:52

Parameters ​
event ​

TrustedEvent

url ​

string

Returns ​

void

onInvalid()? ​

optional onInvalid: (event, url) => void

Defined in: packages/net/src/request.ts:51

Parameters ​
event ​

unknown

url ​

string

Returns ​

void

priority? ​

optional priority: number

Defined in: packages/net/src/request.ts:43

resubscribeAttempts? ​

optional resubscribeAttempts: number

Defined in: packages/net/src/request.ts:47

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/request.ts:42

tracker? ​

optional tracker: Tracker

Defined in: packages/net/src/request.ts:44

ClientAuth ​

ClientAuth = [Auth, ...ClientAuthPayload]

Defined in: packages/net/src/message.ts:115

ClientAuthPayload ​

ClientAuthPayload = [string]

Defined in: packages/net/src/message.ts:103

ClientClose ​

ClientClose = [Close, ...ClientClosePayload]

Defined in: packages/net/src/message.ts:117

ClientClosePayload ​

ClientClosePayload = [string]

Defined in: packages/net/src/message.ts:105

ClientEvent ​

ClientEvent = [Event, ...ClientEventPayload]

Defined in: packages/net/src/message.ts:119

ClientEventPayload ​

ClientEventPayload = [SignedEvent]

Defined in: packages/net/src/message.ts:107

ClientMessage ​

ClientMessage = any[]

Defined in: packages/net/src/message.ts:101

ClientNegClose ​

ClientNegClose = [NegClose, ...ClientNegClosePayload]

Defined in: packages/net/src/message.ts:121

ClientNegClosePayload ​

ClientNegClosePayload = [string]

Defined in: packages/net/src/message.ts:109

ClientNegOpen ​

ClientNegOpen = [NegOpen, ...ClientNegOpenPayload]

Defined in: packages/net/src/message.ts:123

ClientNegOpenPayload ​

ClientNegOpenPayload = [string, Filter, string]

Defined in: packages/net/src/message.ts:111

ClientReq ​

ClientReq = [Req, ...ClientReqPayload]

Defined in: packages/net/src/message.ts:125

ClientReqPayload ​

ClientReqPayload = [string, Filter]

Defined in: packages/net/src/message.ts:113

DifferenceEvents ​

DifferenceEvents = object

Defined in: packages/net/src/diff.ts:22

Properties ​

close() ​

close: () => void

Defined in: packages/net/src/diff.ts:25

Returns ​

void

error() ​

error: (error, url) => void

Defined in: packages/net/src/diff.ts:24

Parameters ​
error ​

string

url ​

string

Returns ​

void

message() ​

message: (payload, url) => void

Defined in: packages/net/src/diff.ts:23

Parameters ​
payload ​
have ​

string[]

need ​

string[]

url ​

string

Returns ​

void

DifferenceOptions ​

DifferenceOptions = object

Defined in: packages/net/src/diff.ts:28

Properties ​

context? ​

optional context: AdapterContext

Defined in: packages/net/src/diff.ts:33

events ​

events: SignedEvent[]

Defined in: packages/net/src/diff.ts:31

filter ​

filter: Filter

Defined in: packages/net/src/diff.ts:30

relay ​

relay: string

Defined in: packages/net/src/diff.ts:29

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/diff.ts:32

DiffItem ​

DiffItem = object

Defined in: packages/net/src/diff.ts:136

Properties ​

have ​

have: Set<string>

Defined in: packages/net/src/diff.ts:138

need ​

need: Set<string>

Defined in: packages/net/src/diff.ts:139

relay ​

relay: string

Defined in: packages/net/src/diff.ts:137

DiffOptions ​

DiffOptions = object

Defined in: packages/net/src/diff.ts:128

Properties ​

context? ​

optional context: AdapterContext

Defined in: packages/net/src/diff.ts:133

events ​

events: SignedEvent[]

Defined in: packages/net/src/diff.ts:131

filters ​

filters: Filter[]

Defined in: packages/net/src/diff.ts:130

relays ​

relays: string[]

Defined in: packages/net/src/diff.ts:129

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/diff.ts:132

IsEventValid() ​

IsEventValid = (event, url) => boolean

Defined in: packages/net/src/request.ts:39

Parameters ​

event ​

TrustedEvent

url ​

string

Returns ​

boolean

Loader() ​

Loader = (options) => Promise<TrustedEvent[]>

Defined in: packages/net/src/request.ts:313

Parameters ​

options ​

LoadOptions

Returns ​

Promise<TrustedEvent[]>

LoaderOptions ​

LoaderOptions = object

Defined in: packages/net/src/request.ts:295

Properties ​

context? ​

optional context: AdapterContext

Defined in: packages/net/src/request.ts:299

delay ​

delay: number

Defined in: packages/net/src/request.ts:296

isEventValid()? ​

optional isEventValid: (event, url) => boolean

Defined in: packages/net/src/request.ts:300

Parameters ​
event ​

TrustedEvent

url ​

string

Returns ​

boolean

threshold? ​

optional threshold: number

Defined in: packages/net/src/request.ts:298

timeout? ​

optional timeout: number

Defined in: packages/net/src/request.ts:297

LoadOptions ​

LoadOptions = object

Defined in: packages/net/src/request.ts:303

Properties ​

filters ​

filters: Filter[]

Defined in: packages/net/src/request.ts:305

onClose()? ​

optional onClose: () => void

Defined in: packages/net/src/request.ts:310

Returns ​

void

onDisconnect()? ​

optional onDisconnect: (url) => void

Defined in: packages/net/src/request.ts:308

Parameters ​
url ​

string

Returns ​

void

onEose()? ​

optional onEose: (url) => void

Defined in: packages/net/src/request.ts:309

Parameters ​
url ​

string

Returns ​

void

onEvent()? ​

optional onEvent: (event, url) => void

Defined in: packages/net/src/request.ts:307

Parameters ​
event ​

TrustedEvent

url ​

string

Returns ​

void

relays ​

relays: string[]

Defined in: packages/net/src/request.ts:304

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/request.ts:306

NetContext ​

NetContext = object

Defined in: packages/net/src/context.ts:7

Properties ​

getAdapter? ​

optional getAdapter: AdapterFactory

Defined in: packages/net/src/context.ts:10

pool? ​

optional pool: Pool

Defined in: packages/net/src/context.ts:8

repository? ​

optional repository: Repository

Defined in: packages/net/src/context.ts:9

PoolSubscription() ​

PoolSubscription = (socket) => void

Defined in: packages/net/src/pool.ts:6

Parameters ​

socket ​

Socket

Returns ​

void

PublishOneOptions ​

PublishOneOptions = object

Defined in: packages/net/src/publish.ts:21

Properties ​

context? ​

optional context: AdapterContext

Defined in: packages/net/src/publish.ts:27

event ​

event: SignedEvent

Defined in: packages/net/src/publish.ts:22

onAborted()? ​

optional onAborted: (result) => void

Defined in: packages/net/src/publish.ts:32

Parameters ​
result ​

PublishResult

Returns ​

void

onComplete()? ​

optional onComplete: (result) => void

Defined in: packages/net/src/publish.ts:33

Parameters ​
result ​

PublishResult

Returns ​

void

onFailure()? ​

optional onFailure: (result) => void

Defined in: packages/net/src/publish.ts:29

Parameters ​
result ​

PublishResult

Returns ​

void

onPending()? ​

optional onPending: (result) => void

Defined in: packages/net/src/publish.ts:30

Parameters ​
result ​

PublishResult

Returns ​

void

onSuccess()? ​

optional onSuccess: (result) => void

Defined in: packages/net/src/publish.ts:28

Parameters ​
result ​

PublishResult

Returns ​

void

onTimeout()? ​

optional onTimeout: (result) => void

Defined in: packages/net/src/publish.ts:31

Parameters ​
result ​

PublishResult

Returns ​

void

priority? ​

optional priority: number

Defined in: packages/net/src/publish.ts:25

relay ​

relay: string

Defined in: packages/net/src/publish.ts:23

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/publish.ts:24

timeout? ​

optional timeout: number

Defined in: packages/net/src/publish.ts:26

PublishOptions ​

PublishOptions = object

Defined in: packages/net/src/publish.ts:127

Properties ​

context? ​

optional context: AdapterContext

Defined in: packages/net/src/publish.ts:133

event ​

event: SignedEvent

Defined in: packages/net/src/publish.ts:128

onAborted()? ​

optional onAborted: (result) => void

Defined in: packages/net/src/publish.ts:138

Parameters ​
result ​

PublishResult

Returns ​

void

onComplete()? ​

optional onComplete: (result) => void

Defined in: packages/net/src/publish.ts:139

Parameters ​
result ​

PublishResult

Returns ​

void

onFailure()? ​

optional onFailure: (result) => void

Defined in: packages/net/src/publish.ts:135

Parameters ​
result ​

PublishResult

Returns ​

void

onPending()? ​

optional onPending: (result) => void

Defined in: packages/net/src/publish.ts:136

Parameters ​
result ​

PublishResult

Returns ​

void

onSuccess()? ​

optional onSuccess: (result) => void

Defined in: packages/net/src/publish.ts:134

Parameters ​
result ​

PublishResult

Returns ​

void

onTimeout()? ​

optional onTimeout: (result) => void

Defined in: packages/net/src/publish.ts:137

Parameters ​
result ​

PublishResult

Returns ​

void

priority? ​

optional priority: number

Defined in: packages/net/src/publish.ts:131

relays ​

relays: string[]

Defined in: packages/net/src/publish.ts:129

signal? ​

optional signal: AbortSignal

Defined in: packages/net/src/publish.ts:130

timeout? ​

optional timeout: number

Defined in: packages/net/src/publish.ts:132

PublishResult ​

PublishResult = object

Defined in: packages/net/src/publish.ts:15

Properties ​

detail ​

detail: string

Defined in: packages/net/src/publish.ts:17

relay ​

relay: string

Defined in: packages/net/src/publish.ts:18

status ​

status: PublishStatus

Defined in: packages/net/src/publish.ts:16

PublishResultsByRelay ​

PublishResultsByRelay = Record<string, PublishResult>

Defined in: packages/net/src/publish.ts:125

PullOptions ​

PullOptions = DiffOptions

Defined in: packages/net/src/diff.ts:190

PushOptions ​

PushOptions = DiffOptions

Defined in: packages/net/src/diff.ts:243

RelayAuth ​

RelayAuth = [Auth, ...RelayAuthPayload]

Defined in: packages/net/src/message.ts:36

RelayAuthPayload ​

RelayAuthPayload = [string]

Defined in: packages/net/src/message.ts:20

RelayClosed ​

RelayClosed = [Closed, ...RelayClosedPayload]

Defined in: packages/net/src/message.ts:38

RelayClosedPayload ​

RelayClosedPayload = [string, string]

Defined in: packages/net/src/message.ts:22

RelayEose ​

RelayEose = [Eose, ...RelayEosePayload]

Defined in: packages/net/src/message.ts:40

RelayEosePayload ​

RelayEosePayload = [string]

Defined in: packages/net/src/message.ts:24

RelayEvent ​

RelayEvent = [Event, ...RelayEventPayload]

Defined in: packages/net/src/message.ts:42

RelayEventPayload ​

RelayEventPayload = [string, SignedEvent]

Defined in: packages/net/src/message.ts:26

RelayMessage ​

RelayMessage = any[]

Defined in: packages/net/src/message.ts:16

RelayNegErr ​

RelayNegErr = [NegErr, ...RelayNegErrPayload]

Defined in: packages/net/src/message.ts:44

RelayNegErrPayload ​

RelayNegErrPayload = [string, string]

Defined in: packages/net/src/message.ts:28

RelayNegMsg ​

RelayNegMsg = [NegMsg, ...RelayNegMsgPayload]

Defined in: packages/net/src/message.ts:46

RelayNegMsgPayload ​

RelayNegMsgPayload = [string, string]

Defined in: packages/net/src/message.ts:30

RelayNotice ​

RelayNotice = [Notice, ...RelayNoticePayload]

Defined in: packages/net/src/message.ts:34

RelayNoticePayload ​

RelayNoticePayload = [string]

Defined in: packages/net/src/message.ts:18

RelayOk ​

RelayOk = [Ok, ...RelayOkPayload]

Defined in: packages/net/src/message.ts:48

RelayOkPayload ​

RelayOkPayload = [string, boolean, string]

Defined in: packages/net/src/message.ts:32

RepositoryUpdate ​

RepositoryUpdate = object

Defined in: packages/net/src/repository.ts:32

Properties ​

added ​

added: TrustedEvent[]

Defined in: packages/net/src/repository.ts:33

removed ​

removed: Set<string>

Defined in: packages/net/src/repository.ts:34

RequestOneOptions ​

RequestOneOptions = BaseRequestOptions & object

Defined in: packages/net/src/request.ts:60

Type declaration ​

filters ​

filters: Filter[]

relay ​

relay: string

RequestOptions ​

RequestOptions = BaseRequestOptions & object

Defined in: packages/net/src/request.ts:255

Type declaration ​

filters ​

filters: Filter[]

relays ​

relays: string[]

threshold? ​

optional threshold: number

SocketEvents ​

SocketEvents = object

Defined in: packages/net/src/socket.ts:25

Properties ​

error() ​

error: (error, url) => void

Defined in: packages/net/src/socket.ts:26

Parameters ​
error ​

string

url ​

string

Returns ​

void

receive() ​

receive: (message, url) => void

Defined in: packages/net/src/socket.ts:30

Parameters ​
message ​

RelayMessage

url ​

string

Returns ​

void

receiving() ​

receiving: (message, url) => void

Defined in: packages/net/src/socket.ts:31

Parameters ​
message ​

RelayMessage

url ​

string

Returns ​

void

send() ​

send: (message, url) => void

Defined in: packages/net/src/socket.ts:28

Parameters ​
message ​

ClientMessage

url ​

string

Returns ​

void

sending() ​

sending: (message, url) => void

Defined in: packages/net/src/socket.ts:29

Parameters ​
message ​

ClientMessage

url ​

string

Returns ​

void

status() ​

status: (status, url) => void

Defined in: packages/net/src/socket.ts:27

Parameters ​
status ​

SocketStatus

url ​

string

Returns ​

void

SocketPolicy() ​

SocketPolicy = (socket) => Unsubscriber

Defined in: packages/net/src/socket.ts:34

Parameters ​

socket ​

Socket

Returns ​

Unsubscriber

SocketPolicyAuthOptions ​

SocketPolicyAuthOptions = object

Defined in: packages/net/src/policy.ts:282

Properties ​

shouldAuth()? ​

optional shouldAuth: (socket) => boolean

Defined in: packages/net/src/policy.ts:284

Parameters ​
socket ​

Socket

Returns ​

boolean

sign() ​

sign: (event) => Promise<SignedEvent>

Defined in: packages/net/src/policy.ts:283

Parameters ​
event ​

StampedEvent

Returns ​

Promise<SignedEvent>

WrapItem ​

WrapItem = Omit<HashedEvent, "content"> & object

Defined in: packages/net/src/wrapManager.ts:6

Type declaration ​

recipient ​

recipient: string

rumorId ​

rumorId: string

WrapManagerOptions ​

WrapManagerOptions = object

Defined in: packages/net/src/wrapManager.ts:13

Properties ​

repository ​

repository: Repository

Defined in: packages/net/src/wrapManager.ts:14

tracker ​

tracker: Tracker

Defined in: packages/net/src/wrapManager.ts:15

WrapReference ​

WrapReference = string[]

Defined in: packages/net/src/wrapManager.ts:11

Variables ​

DEFAULT_PRIORITY ​

const DEFAULT_PRIORITY: 0 = 0

Defined in: packages/net/src/message.ts:147

defaultSocketPolicies ​

const defaultSocketPolicies: SocketPolicy[]

Defined in: packages/net/src/policy.ts:308

load ​

const load: Loader

Defined in: packages/net/src/request.ts:438

LOCAL_RELAY_URL ​

const LOCAL_RELAY_URL: "local://welshman.relay/" = "local://welshman.relay/"

Defined in: packages/net/src/repository.ts:28

MessagePriority ​

const MessagePriority: typeof MessagePriority

Defined in: packages/net/src/message.ts:145

Functions ​

copyPriority() ​

copyPriority<T>(message, source): T

Defined in: packages/net/src/message.ts:163

Type Parameters ​

T ​

T extends ClientMessage

Parameters ​

message ​

T

source ​

ClientMessage

Returns ​

T

diff() ​

diff(__namedParameters): Promise<object[]>

Defined in: packages/net/src/diff.ts:142

Parameters ​

__namedParameters ​

DiffOptions

Returns ​

Promise<object[]>

getAdapter() ​

getAdapter(url, context): AbstractAdapter | SocketAdapter | LocalAdapter

Defined in: packages/net/src/adapter.ts:153

Parameters ​

url ​

string

context ​

Partial = {}

Returns ​

AbstractAdapter | SocketAdapter | LocalAdapter

getPriority() ​

getPriority(message): number

Defined in: packages/net/src/message.ts:160

Parameters ​

message ​

ClientMessage

Returns ​

number

isClientAuth() ​

isClientAuth(m): m is [Auth, string]

Defined in: packages/net/src/message.ts:127

Parameters ​

m ​

ClientMessage

Returns ​

m is [Auth, string]

isClientClose() ​

isClientClose(m): m is [Close, string]

Defined in: packages/net/src/message.ts:129

Parameters ​

m ​

ClientMessage

Returns ​

m is [Close, string]

isClientEvent() ​

isClientEvent(m): m is [Event, SignedEvent]

Defined in: packages/net/src/message.ts:132

Parameters ​

m ​

ClientMessage

Returns ​

m is [Event, SignedEvent]

isClientNegClose() ​

isClientNegClose(m): m is [NegClose, string]

Defined in: packages/net/src/message.ts:135

Parameters ​

m ​

ClientMessage

Returns ​

m is [NegClose, string]

isClientNegOpen() ​

isClientNegOpen(m): m is [NegOpen, string, Filter, string]

Defined in: packages/net/src/message.ts:138

Parameters ​

m ​

ClientMessage

Returns ​

m is [NegOpen, string, Filter, string]

isClientReq() ​

isClientReq(m): m is [Req, string, Filter]

Defined in: packages/net/src/message.ts:141

Parameters ​

m ​

ClientMessage

Returns ​

m is [Req, string, Filter]

isRelayAuth() ​

isRelayAuth(m): m is [Auth, string]

Defined in: packages/net/src/message.ts:52

Parameters ​

m ​

RelayMessage

Returns ​

m is [Auth, string]

isRelayClosed() ​

isRelayClosed(m): m is [Closed, string, string]

Defined in: packages/net/src/message.ts:54

Parameters ​

m ​

RelayMessage

Returns ​

m is [Closed, string, string]

isRelayEose() ​

isRelayEose(m): m is [Eose, string]

Defined in: packages/net/src/message.ts:56

Parameters ​

m ​

RelayMessage

Returns ​

m is [Eose, string]

isRelayEvent() ​

isRelayEvent(m): m is [Event, string, SignedEvent]

Defined in: packages/net/src/message.ts:58

Parameters ​

m ​

RelayMessage

Returns ​

m is [Event, string, SignedEvent]

isRelayNegErr() ​

isRelayNegErr(m): m is [NegErr, string, string]

Defined in: packages/net/src/message.ts:60

Parameters ​

m ​

RelayMessage

Returns ​

m is [NegErr, string, string]

isRelayNegMsg() ​

isRelayNegMsg(m): m is [NegMsg, string, string]

Defined in: packages/net/src/message.ts:62

Parameters ​

m ​

RelayMessage

Returns ​

m is [NegMsg, string, string]

isRelayNotice() ​

isRelayNotice(m): m is [Notice, string]

Defined in: packages/net/src/message.ts:50

Parameters ​

m ​

RelayMessage

Returns ​

m is [Notice, string]

isRelayOk() ​

isRelayOk(m): m is [Ok, string, boolean, string]

Defined in: packages/net/src/message.ts:64

Parameters ​

m ​

RelayMessage

Returns ​

m is [Ok, string, boolean, string]

isTerminalReason() ​

isTerminalReason(reason): boolean

Defined in: packages/net/src/message.ts:79

Parameters ​

reason ​

string = ""

Returns ​

boolean

makeLoader() ​

makeLoader(options): Loader

Defined in: packages/net/src/request.ts:322

Creates a convenience function which returns a promise of events from a request. It may return early if filter cardinality is known, and it delays requests in order to implement batching

Parameters ​

options ​

LoaderOptions

LoaderOptions

Returns ​

Loader

  • a load function

makeSocketPolicyAuth() ​

makeSocketPolicyAuth(options): (socket) => () => void

Defined in: packages/net/src/policy.ts:292

Factory function for a policy which may authenticate the socket

Parameters ​

options ​

SocketPolicyAuthOptions

SocketPolicyAuthOptions object

Returns ​

a socket policy

(socket): () => void

Parameters ​
socket ​

Socket

Returns ​

(): void

Returns ​

void

matchReason() ​

matchReason(prefix, reason): boolean

Defined in: packages/net/src/message.ts:76

Parameters ​

prefix ​

RelayReasonPrefix

reason ​

string

Returns ​

boolean

mergeRepositoryUpdates() ​

mergeRepositoryUpdates(updates): RepositoryUpdate

Defined in: packages/net/src/repository.ts:37

Parameters ​

updates ​

RepositoryUpdate[]

Returns ​

RepositoryUpdate

publish() ​

publish(options): Promise<PublishResultsByRelay>

Defined in: packages/net/src/publish.ts:142

Parameters ​

options ​

PublishOptions

Returns ​

Promise<PublishResultsByRelay>

publishOne() ​

publishOne(options): Promise<PublishResult>

Defined in: packages/net/src/publish.ts:36

Parameters ​

options ​

PublishOneOptions

Returns ​

Promise<PublishResult>

pull() ​

pull(__namedParameters): Promise<TrustedEvent[]>

Defined in: packages/net/src/diff.ts:192

Parameters ​

__namedParameters ​

DiffOptions

Returns ​

Promise<TrustedEvent[]>

push() ​

push(__namedParameters): Promise<void>

Defined in: packages/net/src/diff.ts:245

Parameters ​

__namedParameters ​

DiffOptions

Returns ​

Promise<void>

request() ​

request(options): Promise<TrustedEvent[]>

Defined in: packages/net/src/request.ts:261

Parameters ​

options ​

RequestOptions

Returns ​

Promise<TrustedEvent[]>

requestOne() ​

requestOne(options): Promise<TrustedEvent[]>

Defined in: packages/net/src/request.ts:65

Parameters ​

options ​

RequestOneOptions

Returns ​

Promise<TrustedEvent[]>

setPriority() ​

setPriority<T>(message, priority): T

Defined in: packages/net/src/message.ts:149

Type Parameters ​

T ​

T extends ClientMessage

Parameters ​

message ​

T

priority ​

number = DEFAULT_PRIORITY

Returns ​

T

socketPolicyAuthBuffer() ​

socketPolicyAuthBuffer(socket): () => void

Defined in: packages/net/src/policy.ts:32

Handles auth-related message management:

  • Defers sending messages when a challenge is pending
  • Re-enqueues event/req messages once if rejected due to auth-required

Parameters ​

socket ​

Socket

a Socket object

Returns ​

a cleanup function

(): void

Returns ​

void

socketPolicyCancelUnsent() ​

socketPolicyCancelUnsent(socket): () => void

Defined in: packages/net/src/policy.ts:103

Drops subscriptions that are closed before they've been sent, along with the close message itself. Besides saving a round trip, this keeps a prioritized close from jumping ahead of its own req, which would leave the subscription open on the relay.

Parameters ​

socket ​

Socket

a Socket object

Returns ​

a cleanup function

(): void

Returns ​

void

socketPolicyConnectOnSend() ​

socketPolicyConnectOnSend(socket): () => void

Defined in: packages/net/src/policy.ts:136

Auto-connects a closed socket when a message is sent unless there was a recent error

Parameters ​

socket ​

Socket

a Socket object

Returns ​

a cleanup function

(): void

Returns ​

void

socketPolicyLifecycle() ​

socketPolicyLifecycle(socket): () => void

Defined in: packages/net/src/policy.ts:171

Owns a socket's lifecycle: closes it once nothing needs it, checks the relay is still there when something does, reopens it, and catches up on what it missed.

Parameters ​

socket ​

Socket

a Socket object

Returns ​

a cleanup function

(): void

Returns ​

void