Class ScopeSet

The ScopeSet class creates a set of scopes. Scopes are case-insensitive, unique values, so the Set object in JS makes the most sense to implement for this class. All scopes are trimmed and converted to lower case strings in intersection and union functions to ensure uniqueness of strings.

Hierarchy

ScopeSet

Index

Constructors

Methods

appendScope appendScopes asArray containsOnlyOIDCScopes containsScope containsScopeSet getScopeCount intersectingScopeSets printScopes printScopesLowerCase removeOIDCScopes removeScope unionScopeSets createSearchScopes fromString

Constructors

constructor

new ScopeSet(inputScopes): ScopeSet
Parameters
- inputScopes: string[]
Returns ScopeSet
- Defined in request/ScopeSet.ts:26

Methods

appendScope

appendScope(newScope): void
Appends single scope if passed
Parameters
- newScope: string
Returns void
- Defined in request/ScopeSet.ts:130

appendScopes

appendScopes(newScopes): void
Appends multiple scopes if passed
Parameters
- newScopes: string[]
Returns void
- Defined in request/ScopeSet.ts:140

asArray

asArray(): string[]
Returns the scopes as an array of string values

Returns string[]
- Defined in request/ScopeSet.ts:223

containsOnlyOIDCScopes

containsOnlyOIDCScopes(): boolean
Check if set of scopes contains only the defaults

Returns boolean
- Defined in request/ScopeSet.ts:115

containsScope

containsScope(scope): boolean
Check if a given scope is present in this set of scopes.
Parameters
- scope: string
Returns boolean
- Defined in request/ScopeSet.ts:88

containsScopeSet

containsScopeSet(scopeSet): boolean
Check if a set of scopes is present in this set of scopes.
Parameters
- scopeSet: ScopeSet
Returns boolean
- Defined in request/ScopeSet.ts:101

getScopeCount

getScopeCount(): number
Returns size of set of scopes.

Returns number
- Defined in request/ScopeSet.ts:216

intersectingScopeSets

intersectingScopeSets(otherScopes): boolean
Check if scopes intersect between this set and another.
Parameters
- otherScopes: ScopeSet
Returns boolean
- Defined in request/ScopeSet.ts:195

printScopes

printScopes(): string
Prints scopes into a space-delimited string

Returns string
- Defined in request/ScopeSet.ts:232

printScopesLowerCase

printScopesLowerCase(): string
Prints scopes into a space-delimited lower-case string (used for caching)

Returns string
- Defined in request/ScopeSet.ts:243

removeOIDCScopes

removeOIDCScopes(): void
Removes default scopes from set of scopes Primarily used to prevent cache misses if the default scopes are not returned from the server

Returns void
- Defined in request/ScopeSet.ts:167

removeScope

removeScope(scope): void
Removes element from set of scopes.
Parameters
- scope: string
Returns void
- Defined in request/ScopeSet.ts:154

unionScopeSets

unionScopeSets(otherScopes): Set<string>
Combines an array of scopes with the current set of scopes.
Parameters
- otherScopes: ScopeSet
Returns Set<string>
- Defined in request/ScopeSet.ts:177

`Static` createSearchScopes

createSearchScopes(inputScopeString): ScopeSet
Creates the set of scopes to search for in cache lookups
Parameters
- inputScopeString: string[]
Returns ScopeSet
- Defined in request/ScopeSet.ts:59

`Static` fromString

fromString(inputScopeString): ScopeSet
Factory method to create ScopeSet from space-delimited string
Parameters
- inputScopeString: string
Returns ScopeSet
- Defined in request/ScopeSet.ts:48

Generated using TypeDoc