Class PathEvent

A event broken down into its core components for easy processing Event Structure: module/path/name:property:method Example: users/system:crud or storage/some/path/file.txt:r

Constructors

constructor

Properties

fullPath methods module name path

Accessors

all create delete none read update

Methods

filter has hasAll hasAllFatal hasFatal toString combine filter has hasAll hasAllFatal hasFatal toString

Constructors

constructor

Properties

fullPath

fullPath: string

Entire path, including the module & name

methods

methods: ASet<Method>

List of methods

module

module: string

First directory in path

name

name: string

Last sagment of path

path

path: string

Path including the name, excluding the module

Accessors

all

  • get all(): boolean

  • All/Wildcard specified

    Returns boolean

  • set all(v): void

  • Parameters

    • v: boolean

    Returns void

create

  • get create(): boolean

  • Create method specified

    Returns boolean

  • set create(v): void

  • Parameters

    • v: boolean

    Returns void

delete

  • get delete(): boolean

  • Delete method specified

    Returns boolean

  • set delete(v): void

  • Parameters

    • v: boolean

    Returns void

none

  • get none(): boolean

  • None specified

    Returns boolean

  • set none(v): void

  • Parameters

    • v: boolean

    Returns void

read

  • get read(): boolean

  • Read method specified

    Returns boolean

  • set read(v): void

  • Parameters

    • v: boolean

    Returns void

update

  • get update(): boolean

  • Update method specified

    Returns boolean

  • set update(v): void

  • Parameters

    • v: boolean

    Returns void

Methods

filter

  • filter(target): PathEvent[]

  • Filter a set of paths based on this event

    Parameters

    Returns PathEvent[]

    Whether there is any overlap

has

  • has(...has): boolean

  • Squash 2 sets of paths & return true if any overlap is found

    Parameters

    • Rest...has: (string | PathEvent)[]

      Target must have at least one of these path

    Returns boolean

    Whether there is any overlap

hasAll

  • hasAll(...has): boolean

  • Squash 2 sets of paths & return true if the target has all paths

    Parameters

    • Rest...has: (string | PathEvent)[]

      Target must have all these paths

    Returns boolean

    Whether there is any overlap

hasAllFatal

  • hasAllFatal(...has): void

  • Same as hasAll but raises an error if the target is missing any paths

    Parameters

    • Rest...has: (string | PathEvent)[]

      Target must have all these paths

    Returns void

hasFatal

  • hasFatal(...has): void

  • Same as has but raises an error if there is no overlap

    Parameters

    • Rest...has: (string | PathEvent)[]

      Target must have at least one of these path

    Returns void

toString

  • toString(): string

  • Create event string from its components

    Returns string

    String representation of Event

Staticcombine

  • combine(...paths): PathEvent

  • Combine multiple events into one parsed object. Longest path takes precedent, but all subsequent methods are combined until a "none" is reached

    Parameters

    • Rest...paths: (string | PathEvent)[]

      Events as strings or pre-parsed

    Returns PathEvent

    Final combined permission

Staticfilter

  • filter(target, ...filter): PathEvent[]

  • Filter a set of paths based on the target

    Parameters

    • target: string | PathEvent | (string | PathEvent)[]

      Array of events that will filtered

    • Rest...filter: (string | PathEvent)[]

      {...PathEvent} Must container one of

    Returns PathEvent[]

    Whether there is any overlap

Statichas

  • has(target, ...has): boolean

  • Squash 2 sets of paths & return true if any overlap is found

    Parameters

    • target: string | PathEvent | (string | PathEvent)[]

      Array of Events as strings or pre-parsed

    • Rest...has: (string | PathEvent)[]

      Target must have at least one of these path

    Returns boolean

    Whether there is any overlap

StatichasAll

  • hasAll(target, ...has): boolean

  • Squash 2 sets of paths & return true if the target has all paths

    Parameters

    • target: string | PathEvent | (string | PathEvent)[]

      Array of Events as strings or pre-parsed

    • Rest...has: (string | PathEvent)[]

      Target must have all these paths

    Returns boolean

    Whether there is any overlap

StatichasAllFatal

  • hasAllFatal(target, ...has): void

  • Same as hasAll but raises an error if the target is missing any paths

    Parameters

    • target: string | PathEvent | (string | PathEvent)[]

      Array of Events as strings or pre-parsed

    • Rest...has: (string | PathEvent)[]

      Target must have all these paths

    Returns void

StatichasFatal

  • hasFatal(target, ...has): void

  • Same as has but raises an error if there is no overlap

    Parameters

    • target: string | PathEvent | (string | PathEvent)[]

      Array of Events as strings or pre-parsed

    • Rest...has: (string | PathEvent)[]

      Target must have at least one of these path

    Returns void

StatictoString

  • toString(path, methods): string

  • Create event string from its components

    Parameters

    • path: string | string[]

      Event path

    • methods: Method | Method[]

      Event method

    Returns string

    String representation of Event

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods