@ptolemy2002/rgx 3.1.1 → 4.0.0

package/README.md

@@ -141,10 +141,16 @@ constructor(tokens: RGXTokenCollectionInput = [], mode: RGXTokenCollectionMode =
 
 Standard array properties and methods like `length`, `push`, `pop`, etc. are implemented to work with the internal `tokens` array, but providing collection instances instead of raw arrays when relevant (e.g., `map` has the third parameter typed as `RGXTokenCollection` instead of `RGXToken[]`).
 
+#### Static Properties
+- `check(value: unknown): value is RGXTokenCollection`: A type guard that checks if the given value is an instance of `RGXTokenCollection`.
+- `assert(value: unknown): asserts value is RGXTokenCollection`: An assertion that checks if the given value is an instance of `RGXTokenCollection`. If the assertion fails, an `RGXInvalidTokenError` will be thrown.
+
 ### RGXClassToken (abstract)
 An abstract base class for creating custom RGX token classes. Subclasses must implement the `toRgx()` method, which returns any valid `RGXToken` (including other convertible tokens, allowing for recursive structures).
 
-Two type guards are provided for this class: `isRgxClassToken` to check if a value is an instance of `RGXClassToken`, and `assertRgxClassToken` to assert that a value is an instance of `RGXClassToken` (throwing an `InvalidTokenError` if the assertion fails). Both of these take a single parameter of type `unknown` for the value.
+#### Static Properties
+- `check(value: unknown): value is RGXClassToken`: A type guard that checks if the given value is an instance of `RGXClassToken`.
+- `assert(value: unknown): asserts value is RGXClassToken`: An assertion that checks if the given value is an instance of `RGXClassToken`. If the assertion fails, an `RGXInvalidTokenError` will be thrown.
 
 #### Abstract Methods
 - `toRgx() => RGXToken`: Must be implemented by subclasses to return the token's regex representation as any valid RGX token (native, literal, convertible, or array of tokens).
@@ -159,7 +165,11 @@ Two type guards are provided for this class: `isRgxClassToken` to check if a val
 ### RGXClassUnionToken extends RGXClassToken
 A class representing a union (alternation) of RGX tokens. This is typically created via the `or()` method on `RGXClassToken`, but can also be instantiated directly.
 
-A function `rgxClassUnion` is provided with the same parameters as this class' constructor, for easier instantiation without needing to use the `new` keyword. Two type guards are provided for this class: `isRgxClassUnionToken` to check if a value is an instance of `RGXClassUnionToken`, and `assertRgxClassUnionToken` to assert that a value is an instance of `RGXClassUnionToken` (throwing an `InvalidTokenError` if the assertion fails). Both of these take a single parameter of type `unknown` for the value.
+A function `rgxClassUnion` is provided with the same parameters as this class' constructor, for easier instantiation without needing to use the `new` keyword.
+
+#### Static Properties
+- `check(value: unknown): value is RGXClassUnionToken`: A type guard that checks if the given value is an instance of `RGXClassUnionToken`.
+- `assert(value: unknown): asserts value is RGXClassUnionToken`: An assertion that checks if the given value is an instance of `RGXClassUnionToken`. If the assertion fails, an `RGXInvalidTokenError` will be thrown.
 
 #### Constructor
 ```typescript

package/dist/class/base.d.ts

@@ -3,9 +3,9 @@ import { RGXTokenCollectionInput } from "../collection";
 import type { RGXClassUnionToken } from "./union";
 export declare abstract class RGXClassToken {
     abstract toRgx(): RGXToken;
+    static check: (value: unknown) => value is RGXClassToken;
+    static assert: (value: unknown) => asserts value is RGXClassToken;
     get isGroup(): boolean;
     or(...others: RGXTokenCollectionInput[]): RGXClassUnionToken;
     resolve(): ValidRegexString;
 }
-export declare const isRgxClassToken: (value: unknown) => value is RGXClassToken;
-export declare const assertRgxClassToken: (value: unknown) => asserts value is RGXClassToken;

package/dist/class/base.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertRgxClassToken = exports.isRgxClassToken = exports.RGXClassToken = void 0;
+exports.RGXClassToken = void 0;
 const errors_1 = require("../errors");
 const resolve_1 = require("../resolve");
 class RGXClassToken {
@@ -17,11 +17,9 @@ class RGXClassToken {
 exports.RGXClassToken = RGXClassToken;
 // The createClassGuard function only accepts non-abstract classes, so we 
 // manually define the guard and assertion functions for RGXClassToken here.
-const isRgxClassToken = (value) => value instanceof RGXClassToken;
-exports.isRgxClassToken = isRgxClassToken;
-const assertRgxClassToken = (value) => {
+RGXClassToken.check = (value) => value instanceof RGXClassToken;
+RGXClassToken.assert = (value) => {
     if (!(value instanceof RGXClassToken)) {
         throw new errors_1.RGXInvalidTokenError("Invalid token type", { type: "custom", values: ["instance of RGXClassToken"] }, value);
     }
 };
-exports.assertRgxClassToken = assertRgxClassToken;

package/dist/class/union.d.ts

@@ -4,6 +4,8 @@ import { RGXClassToken } from "./base";
 export type RGXUnionInsertionPosition = 'prefix' | 'suffix';
 export declare class RGXClassUnionToken extends RGXClassToken {
     tokens: RGXTokenCollection;
+    static check: (value: unknown) => value is RGXClassUnionToken;
+    static assert: (value: unknown) => asserts value is RGXClassUnionToken;
     get isGroup(): boolean;
     constructor(tokens?: RGXTokenCollectionInput);
     cleanTokens(): this;
@@ -14,5 +16,3 @@ export declare class RGXClassUnionToken extends RGXClassToken {
 export declare function expandRgxUnionTokens(...tokens: RGXTokenCollectionInput[]): RGXTokenCollection;
 export declare function removeRgxUnionDuplicates(...tokens: RGXTokenCollectionInput[]): RGXTokenCollection;
 export declare const rgxClassUnion: (tokens?: RGXTokenCollectionInput) => RGXClassUnionToken;
-export declare const isRgxClassUnionToken: (value: unknown) => value is RGXClassUnionToken;
-export declare const assertRgxClassUnionToken: (value: unknown) => asserts value is RGXClassUnionToken;

package/dist/class/union.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertRgxClassUnionToken = exports.isRgxClassUnionToken = exports.rgxClassUnion = exports.RGXClassUnionToken = void 0;
+exports.rgxClassUnion = exports.RGXClassUnionToken = void 0;
 exports.expandRgxUnionTokens = expandRgxUnionTokens;
 exports.removeRgxUnionDuplicates = removeRgxUnionDuplicates;
 const internal_1 = require("../internal");
@@ -49,6 +49,8 @@ class RGXClassUnionToken extends base_1.RGXClassToken {
     }
 }
 exports.RGXClassUnionToken = RGXClassUnionToken;
+RGXClassUnionToken.check = (0, internal_1.createClassGuardFunction)(RGXClassUnionToken);
+RGXClassUnionToken.assert = (0, internal_1.createAssertClassGuardFunction)(RGXClassUnionToken);
 function expandRgxUnionTokens(...tokens) {
     const result = new collection_1.RGXTokenCollection();
     for (const token of tokens) {
@@ -87,5 +89,3 @@ function removeRgxUnionDuplicates(...tokens) {
     return new collection_1.RGXTokenCollection(uniqueTokens, 'union');
 }
 exports.rgxClassUnion = (0, internal_1.createConstructFunction)(RGXClassUnionToken);
-exports.isRgxClassUnionToken = (0, internal_1.createClassGuardFunction)(RGXClassUnionToken);
-exports.assertRgxClassUnionToken = (0, internal_1.createAssertClassGuardFunction)(RGXClassUnionToken);

package/dist/collection.d.ts

@@ -6,6 +6,8 @@ export type RGXTokenCollectionInput = RGXToken | RGXTokenCollection;
 export declare class RGXTokenCollection implements Collection<RGXToken> {
     mode: RGXTokenCollectionMode;
     tokens: RGXToken[];
+    static check: (value: unknown) => value is RGXTokenCollection;
+    static assert: (value: unknown) => asserts value is RGXTokenCollection;
     constructor(tokens?: RGXTokenCollectionInput, mode?: RGXTokenCollectionMode);
     toRgx(): RegExp;
     getTokens(): RGXToken[];

package/dist/collection.js

@@ -164,4 +164,6 @@ class RGXTokenCollection {
     }
 }
 exports.RGXTokenCollection = RGXTokenCollection;
+RGXTokenCollection.check = (0, internal_1.createClassGuardFunction)(RGXTokenCollection);
+RGXTokenCollection.assert = (0, internal_1.createAssertClassGuardFunction)(RGXTokenCollection);
 exports.rgxTokenCollection = (0, internal_1.createConstructFunction)(RGXTokenCollection);

package/dist/errors/invalidToken.js

@@ -46,7 +46,7 @@ class RGXInvalidTokenError extends errors_1.RGXError {
         this.setExpected(expected);
     }
     toString() {
-        const gotString = (0, class_1.isRgxClassToken)(this.got) ? `instance of ${this.got.constructor.name}` : JSON.stringify(this.got);
+        const gotString = class_1.RGXClassToken.check(this.got) ? `instance of ${this.got.constructor.name}` : JSON.stringify(this.got);
         return `${this.name}: ${this.message}; Expected: ${this.expected}; Got: [${gotString}]`;
     }
 }

package/dist/typeGuards.js

@@ -58,9 +58,9 @@ exports.assertValidRegexString = assertValidRegexString;
 exports.isValidVanillaRegexFlags = isValidVanillaRegexFlags;
 exports.assertValidVanillaRegexFlags = assertValidVanillaRegexFlags;
 const e = __importStar(require("./errors"));
-const class_1 = require("./class");
 const is_callable_1 = __importDefault(require("is-callable"));
 const internal_1 = require("./internal");
+const class_1 = require("./class");
 function isRGXNoOpToken(value) {
     return value === null || value === undefined;
 }
@@ -122,7 +122,7 @@ function rgxTokenTypeFlat(value, recognizeClass = true) {
     if (isRGXNativeToken(value))
         return 'native';
     // We have to check class before convertible because class tokens are also convertible.
-    if (recognizeClass && (0, class_1.isRgxClassToken)(value))
+    if (recognizeClass && class_1.RGXClassToken.check(value))
         return 'class';
     if (isRGXConvertibleToken(value))
         return 'convertible';
@@ -167,7 +167,7 @@ function isRGXToken(value, type = null, matchLength = true) {
     if (typeMatches('native') && isRGXNativeToken(value))
         return true;
     // We have to check class before convertible because class tokens are also convertible.
-    if (typeMatches('class') && (0, class_1.isRgxClassToken)(value))
+    if (typeMatches('class') && class_1.RGXClassToken.check(value))
         return true;
     if (typeMatches('convertible') && isRGXConvertibleToken(value))
         return true;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/rgx",
-    "version": "3.1.1",
+    "version": "4.0.0",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",