Class Permissions

Class to hold a Base and External permission set

Index

Constructors

Properties

BaseSet ExternalSet isInstance toJSONSerializablePrefix

Accessors

base canUseDelegation external toUpdateRequires

Methods

combine compare has remove validate combine FromAcceptedTypes remove toJSONSerializable

Constructors

constructor

new Permissions(
baseFlags?: bigint | BaseSet | BaseFlagNames,
externalOffsets?: bigint | number[] | ExternalSet,
): Permissions
Parameters
- baseFlags: bigint | BaseSet | BaseFlagNames = []
- externalOffsets: bigint | number[] | ExternalSet = []
Returns Permissions

Properties

`Static`BaseSet

BaseSet: typeof BaseSet = BaseSet

`Static`ExternalSet

ExternalSet: typeof ExternalSet = ExternalSet

`Static`isInstance

isInstance: (obj: any, strict?: boolean) => obj is Permissions = ...

`Static`toJSONSerializablePrefix

toJSONSerializablePrefix: string = 'PERMISSIONS'

Accessors

base

get base(): BaseSet
Returns BaseSet

canUseDelegation

get canUseDelegation(): boolean
Returns boolean

external

get external(): ExternalSet
Returns ExternalSet

toUpdateRequires

get toUpdateRequires(): Permissions
Returns Permissions

Methods

combine

combine(toCombine: Permissions): Permissions
Parameters
- toCombine: Permissions
Returns Permissions

compare

compare(toCompare?: Permissions): boolean
Parameters
- OptionaltoCompare: Permissions
Returns boolean

has

has(flags: BaseFlagNames, offsets?: number[]): boolean
Parameters
- flags: BaseFlagNames
- Optionaloffsets: number[]
Returns boolean
has(instance: Permissions): boolean
Parameters
- instance: Permissions
Returns boolean

remove

remove(toRemove: Permissions): Permissions
Parameters
- toRemove: Permissions
Returns Permissions

validate

validate(network: bigint): boolean
Parameters
- network: bigint
Returns boolean

`Static`combine

combine(combineFrom: Permissions, toCombine: Permissions): Permissions
Parameters
- combineFrom: Permissions
- toCombine: Permissions
Returns Permissions

`Static`FromAcceptedTypes

FromAcceptedTypes(perms: AcceptedPermissionTypes): Permissions
Parameters
- perms: AcceptedPermissionTypes
Returns Permissions

`Static`remove

remove(removeFrom: Permissions, toRemove: Permissions): Permissions
Parameters
- removeFrom: Permissions
- toRemove: Permissions
Returns Permissions

`Static`toJSONSerializable

toJSONSerializable(value: Permissions): bigint[]
Parameters
- value: Permissions
Returns bigint[]