Interface ClaimSet

A Set of claims that can be used to verify claims requested by OAuth clients.

A ClaimSet is an immutable type, and all methods returning a ClaimSet return new instances.

Hierarchy

  • ClaimSet

Properties

all allClaimNames onlyRequiredClaims

Methods

areAllIn contains containsAll filtered get getAll getAllClaimNames getOnlyRequiredClaims isEmpty union

Properties

all

all: any[]

Returns a Set of all claims in this ClaimSet.

allClaimNames

allClaimNames: any[]

Returns the Set of names of all claims in this ClaimSet.

onlyRequiredClaims

onlyRequiredClaims: ClaimSet

Returns a new ClaimSet containing only claims where ClaimConfig#isRequired() returns true.

Methods

areAllIn

  • Check whether this ClaimSet is a subset of the given set of claim names; i.e. this set is a subset of the given set.

    Parameters

    • claimNames: string[]

    Returns boolean

contains

  • Check whether this ClaimSet contains a claim with the given name.

    Parameters

    • claimName: string

    Returns boolean

containsAll

  • Check whether this ClaimSet contains all the named claims.

    Parameters

    • claimNames: string[]

    Returns boolean

filtered

  • Filters this ClaimSet given a set of claim names; returning only the set of claims named.

    Parameters

    • claimNames: any[]

    Returns ClaimSet

  • Filters this ClaimSet given a map of scopes; returning the set of claims covered by those scopes.

    Parameters

    Returns ClaimSet

get

  • Get the claim with the given name.

    Parameters

    • claimName: string

    Returns null | ClaimConfig

getAll

  • Returns a Set of all claims in this ClaimSet.

    Returns any[]

getAllClaimNames

  • Returns the Set of names of all claims in this ClaimSet.

    Returns any[]

getOnlyRequiredClaims

  • Returns a new ClaimSet containing only claims where ClaimConfig#isRequired() returns true.

    Returns ClaimSet

isEmpty

  • Check whether this ClaimSet is empty.

    Returns boolean

union

  • Returns a new ClaimSet that is the union of the given ClaimSet and this. On overlapping claims, the claims maintained by this ClaimSet are preserved.

    Parameters

    Returns ClaimSet

Settings

Member Visibility

Theme