Class Permissions

An allow set and a deny set of privileges.

Index

Accessors

Methods

from allowAll addAllow addDeny removeAllow removeDeny clearAllPermissions addToEnvelope fromEnvelope equals clone

Accessors

allow

get allow(): ReadonlySet<Privilege>
The allowed privileges (a copy).

Returns ReadonlySet<Privilege>
- Defined in permissions.ts:67

deny

get deny(): ReadonlySet<Privilege>
The denied privileges (a copy).

Returns ReadonlySet<Privilege>
- Defined in permissions.ts:72

Methods

`Static`from

from(__namedParameters?: PermissionsInput): Permissions
Empty sets unless given.
Parameters
- __namedParameters: PermissionsInput = {}
Returns Permissions
- Defined in permissions.ts:57

`Static`allowAll

allowAll(): Permissions
All allowed, nothing denied.

Returns Permissions
- Defined in permissions.ts:62

addAllow

addAllow(privilege: Privilege): void
Allows privilege.
Parameters
- privilege: Privilege
Returns void
- Defined in permissions.ts:77

addDeny

addDeny(privilege: Privilege): void
Denies privilege.
Parameters
- privilege: Privilege
Returns void
- Defined in permissions.ts:82

removeAllow

removeAllow(privilege: Privilege): void
Stops allowing privilege.
Parameters
- privilege: Privilege
Returns void
- Defined in permissions.ts:87

removeDeny

removeDeny(privilege: Privilege): void
Stops denying privilege.
Parameters
- privilege: Privilege
Returns void
- Defined in permissions.ts:92

clearAllPermissions

clearAllPermissions(): void
Empties both sets.

Returns void
- Defined in permissions.ts:97

addToEnvelope

addToEnvelope(envelope: Envelope): Envelope
Adds an 'allow' assertion per allowed privilege, then a 'deny' per denied one.
Parameters
- envelope: Envelope
Returns Envelope
- Defined in permissions.ts:103

`Static`fromEnvelope

fromEnvelope(envelope: Envelope): Permissions
The 'allow' and 'deny' assertions of an envelope. An object that is not a known value is EnvelopeParsing; one that names no privilege is UnknownPrivilege.
Parameters
- envelope: Envelope
Returns Permissions
- Defined in permissions.ts:125

equals

equals(other: Permissions): boolean
Same allow and deny sets.
Parameters
- other: Permissions
Returns boolean
- Defined in permissions.ts:134

clone

clone(): Permissions
A copy.

Returns Permissions
- Defined in permissions.ts:143