@ztimson/utils 0.19.1 → 0.19.2

package/dist/path-events.d.ts

@@ -10,20 +10,20 @@
  */
 export type Method = '*' | 'n' | 'c' | 'r' | 'u' | 'd' | 'x';
 /**
- * Shorthand for creating PathedEvent from a string
+ * Shorthand for creating Event from a string
  *
  * @example
  * ```ts
- * const event: PathedEvent = PE`users/system:*`;
+ * const event: Event = PE`users/system:*`;
  * ```
  *
- * @param {TemplateStringsArray} str String that will be parsed into PathedEvent
+ * @param {TemplateStringsArray} str String that will be parsed into Event
  * @param {string} args
- * @return {PathEvent} PathedEvent object
+ * @return {PathEvent} Event object
  */
 export declare function PE(str: TemplateStringsArray, ...args: string[]): PathEvent;
 /**
- * Shorthand for creating PathedEvent strings, ensures paths are correct
+ * Shorthand for creating Event strings, ensures paths are correct
  *
  * @param {TemplateStringsArray} str
  * @param {string} args
@@ -32,8 +32,8 @@ export declare function PE(str: TemplateStringsArray, ...args: string[]): PathEv
  */
 export declare function PES(str: TemplateStringsArray, ...args: any[]): string;
 /**
- * A pathed event broken down into its core components for easy processing
- * PathedEvent Structure: `module/path/name:property:method`
+ * 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`
  */
 export declare class PathEvent {
@@ -59,19 +59,19 @@ export declare class PathEvent {
     update: boolean;
     /** Delete method specified */
     delete: boolean;
-    constructor(pathedEvent: string | PathEvent);
+    constructor(Event: string | PathEvent);
     /**
-     * Combine multiple pathed events into one parsed object. Longest path takes precedent, but all subsequent methods are
+     * Combine multiple  events into one parsed object. Longest path takes precedent, but all subsequent methods are
      * combined until a "none" is reached
      *
-     * @param {string | PathEvent} paths PathedEvents as strings or pre-parsed
+     * @param {string | PathEvent} paths Events as strings or pre-parsed
      * @return {PathEvent} Final combined permission
      */
     static combine(paths: (string | PathEvent)[]): PathEvent;
     /**
      * Squash 2 sets of paths & return true if any overlap is found
      *
-     * @param {string | PathEvent | (string | PathEvent)[]} target Array of PathedEvents as strings or pre-parsed
+     * @param {string | PathEvent | (string | PathEvent)[]} target Array of Events as strings or pre-parsed
      * @param has Target must have at least one of these path
      * @return {boolean} Whether there is any overlap
      */
@@ -79,7 +79,7 @@ export declare class PathEvent {
     /**
      * Squash 2 sets of paths & return true if the target has all paths
      *
-     * @param {string | PathEvent | (string | PathEvent)[]} target Array of PathedEvents as strings or pre-parsed
+     * @param {string | PathEvent | (string | PathEvent)[]} target Array of Events as strings or pre-parsed
      * @param has Target must have all these paths
      * @return {boolean} Whether there is any overlap
      */
@@ -87,35 +87,35 @@ export declare class PathEvent {
     /**
      * Same as `has` but raises an error if there is no overlap
      *
-     * @param {string | string[]} target Array of PathedEvents as strings or pre-parsed
+     * @param {string | string[]} target Array of Events as strings or pre-parsed
      * @param has Target must have at least one of these path
      */
     static hasFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void;
     /**
      * Same as `hasAll` but raises an error if the target is missing any paths
      *
-     * @param {string | string[]} target Array of PathedEvents as strings or pre-parsed
+     * @param {string | string[]} target Array of Events as strings or pre-parsed
      * @param has Target must have all these paths
      */
     static hasAllFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void;
     /**
-     * Create pathed event string from its components
+     * Create  event string from its components
      *
      * @param {string | string[]} path Event path
      * @param {Method} methods Event method
-     * @return {string} String representation of PathedEvent
+     * @return {string} String representation of Event
      */
     static toString(path: string | string[], methods: Method | Method[]): string;
     /**
-     * Create pathed event string from its components
+     * Create  event string from its components
      *
-     * @return {string} String representation of PathedEvent
+     * @return {string} String representation of Event
      */
     toString(): string;
 }
 export type PathListener = (event: PathEvent, ...args: any[]) => any;
 export type PathUnsubscribe = () => void;
-export interface IPathedEventEmitter {
+export interface IPathEventEmitter {
     emit(event: string, ...args: any[]): void;
     off(listener: PathListener): void;
     on(event: string, listener: PathListener): PathUnsubscribe;
@@ -125,11 +125,11 @@ export interface IPathedEventEmitter {
 /**
  * Event emitter that uses paths allowing listeners to listen to different combinations of modules, paths & methods
  */
-export declare class PathEventEmitter implements IPathedEventEmitter {
+export declare class PathEventEmitter implements IPathEventEmitter {
     private listeners;
     emit(event: string | PathEvent, ...args: any[]): void;
     off(listener: PathListener): void;
     on(event: string | string[], listener: PathListener): PathUnsubscribe;
     once(event: string | string[], listener?: PathListener): Promise<any>;
-    relayEvents(emitter: IPathedEventEmitter): void;
+    relayEvents(emitter: IPathEventEmitter): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.19.1",
+	"version": "0.19.2",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",