Interface: IssueRoomfulTokenOptions
@roomful/next / IssueRoomfulTokenOptions
Interface: IssueRoomfulTokenOptions
Section titled “Interface: IssueRoomfulTokenOptions”Defined in: packages/next/src/index.ts:4
Configures issueRoomfulToken.
Properties
Section titled “Properties”claims?
Section titled “claims?”
optionalclaims:Record<string,unknown>
Defined in: packages/next/src/index.ts:42
Merges additional claims into the JWT payload.
expiresInSeconds?
Section titled “expiresInSeconds?”
optionalexpiresInSeconds:number
Defined in: packages/next/src/index.ts:25
Controls how many seconds from issuedAt the token remains valid.
Default Value
Section titled “Default Value”3600issuedAt?
Section titled “issuedAt?”
optionalissuedAt:number
Defined in: packages/next/src/index.ts:37
Overrides the iat claim, expressed as a Unix timestamp in seconds.
Default Value
Section titled “Default Value”The current time in seconds.notBeforeSeconds?
Section titled “notBeforeSeconds?”
optionalnotBeforeSeconds:number
Defined in: packages/next/src/index.ts:30
Delays activation by setting the nbf claim this many seconds after issuedAt.
roomId?
Section titled “roomId?”
optionalroomId:string
Defined in: packages/next/src/index.ts:18
Sets the roomId claim scoping the token to a room.
secret
Section titled “secret”secret:
string
Defined in: packages/next/src/index.ts:8
Supplies the relay shared secret (the relay --auth-secret) used to sign the token.
subject?
Section titled “subject?”
optionalsubject:string
Defined in: packages/next/src/index.ts:13
Sets the sub claim identifying the token subject.