Class Principal<T>

constructor

• new Principal<T = unknown>(
      isAuthenticated: boolean,
      value: T | undefined,
      claims?: Map<string, string | string[]>,
  ): Principal<T>

  Type Parameters

  • T = unknown

  Parameters

  • isAuthenticated: boolean
  • value: T | undefined
  • Optionalclaims: Map<string, string | string[]>

  Returns Principal<T>

Readonlyclaims

ReadonlyisAuthenticated

Readonlyvalue

hasClaim

• hasClaim(type: string, value?: string): boolean

  Returns true if the principal has a claim with the given type. If value is provided, also checks the claim value matches.

  Parameters

  • type: string
  • Optionalvalue: string

  Returns boolean

hasRole

• hasRole(role: string, claimKey?: string): boolean

  Returns true if the principal has the given role. Checks the "role" claim by default; supports both single-value and array-value claims.

  Parameters

  • role: string
  • claimKey: string = 'role'

  Returns boolean

Staticanonymous

• anonymous(): Principal<undefined>

  Creates an anonymous (unauthenticated) principal.

  Returns Principal<undefined>