Interface Authorization

Authorization data.

interface Authorization {
    getName(): undefined | string;
    getRoles(): string[];
    hasRole(name: string): boolean;
    readonly [key: string]: unknown;
}

Indexable

  • readonly [key: string]: unknown

    may have extra keys

Methods

getName getRoles hasRole

Methods

getName

  • getName(): undefined | string

  • Gets the name of the User that this Authorization context was created for. or undefined if created for not authenticated user.

    Returns undefined | string

getRoles

  • getRoles(): string[]

  • Gets the names of all roles implied by this Authorization context.

    Returns string[]

hasRole

  • hasRole(name: string): boolean

  • Checks if the role with the specified name is implied by this Authorization context.

    Parameters

    • name: string

      The name of the role to check for.

    Returns boolean

Settings

Member Visibility

On This Page

Methods