minca
ApiCoreInterfaces

Interface: RelayKind

Defined in: packages/core/src/network/relays.ts:92

A kind of relay (spec 04 §1.2)

Properties

PropertyModifierTypeDescriptionDefined in
canreadonlyobjectWhat it does beyond the contract every relay meetspackages/core/src/network/relays.ts:98
can.icereadonlybooleanIt may hand out TURN passwords (spec 04 §1.4)packages/core/src/network/relays.ts:102
can.purgereadonlybooleanAn inbox's owner can clear what others dropped (spec 07 §5)packages/core/src/network/relays.ts:100
linkreadonly(url) => RelayLink-packages/core/src/network/relays.ts:95
mailboxreadonly(options) => RelayMailbox-packages/core/src/network/relays.ts:96
schemesreadonlyreadonly string[]The URL schemes that name it, lower casepackages/core/src/network/relays.ts:94

On this page