GuestPasses

Anonymous passes: “.”, the mac binds the pass to one scope (a public link, a lobby page). Nothing is stored.

Constructors

Constructor

new GuestPasses(secret): GuestPasses

Parameters

secret

string | Buffer<ArrayBufferLike>

Returns

GuestPasses

Methods

check()

check(scope, value): string | null

The pass id (never the pass itself) when the value is a pass for this scope, else null.

Parameters

scope

string

value

string | undefined

Returns

string | null

---

issue()

issue(scope): string

Parameters

scope

string

Returns

string

---

cookie()

static cookie(name, pass, path, secure, maxAgeSec?): string

The Set-Cookie value for a pass (HttpOnly, SameSite=Strict, limited to path).

Parameters

name

string

pass

string

path

string

secure

boolean

maxAgeSec?

number = ...

Returns

string

---

defaultName()

static defaultName(id): string

“Guest 4821”: a stable default name from a pass id.

Parameters

id

string

Returns

string