Interface: RoomfulTokenRouteOptions
@roomful/next / RoomfulTokenRouteOptions
Interface: RoomfulTokenRouteOptions
Section titled “Interface: RoomfulTokenRouteOptions”Defined in: packages/next/src/index.ts:73
Configures createRoomfulTokenRoute.
Properties
Section titled “Properties”authorize()?
Section titled “authorize()?”
optionalauthorize: (request) =>Promise<RoomfulTokenAuthorizeResult|Response>
Defined in: packages/next/src/index.ts:88
Authorizes the incoming request before a token is minted.
Return a RoomfulTokenAuthorizeResult to issue a token with those claims, or return a
Response to short-circuit the handler (for example, a 401/403 rejection).
Parameters
Section titled “Parameters”request
Section titled “request”Request
The incoming request.
Returns
Section titled “Returns”Promise<RoomfulTokenAuthorizeResult | Response>
The token parameters, or a Response to return verbatim.
expiresInSeconds?
Section titled “expiresInSeconds?”
optionalexpiresInSeconds:number
Defined in: packages/next/src/index.ts:95
Sets the default token lifetime in seconds when authorize does not override it.
Default Value
Section titled “Default Value”3600secret
Section titled “secret”secret:
string
Defined in: packages/next/src/index.ts:77
Supplies the relay shared secret used to sign issued tokens.