@ptolemy2002/rgx 2.7.0 → 2.7.1

package/README.md

@@ -305,10 +305,10 @@ Asserts that the given value is an array of RGX tokens. Validates that the value
 
 ### rgxTokenType
 ```typescript
-function rgxTokenType(value: RGXToken): RGXTokenType
+function rgxTokenType(value: unknown): RGXTokenType
 ```
 
-Determines the type of a given RGX token (`no-op`, `literal`, `native`, `convertible`, or an array of the former).
+Determines the type of a given RGX token value (`no-op`, `literal`, `native`, `convertible`, or an array of the former) or throws an error if the value is not a valid RGX token.
 
 If you narrow the result of this function to something more specific, you can then convert these string or array literals into their corresponding token types using the `RGXTokenFromType` utility type or `rgxTokenFromType` function.
 
@@ -323,16 +323,16 @@ if (type === 'native') {
 ```
 
 #### Parameters
-  - `value` (`RGXToken`): The RGX token to check.
+  - `value` (`unknown`): The value to check.
 
 #### Returns
 - `RGXTokenType`: The type of the RGX token.
 
 ### rgxTokenTypeFlat
 ```typescript
-function rgxTokenTypeFlat(value: RGXToken): RGXTokenTypeFlat
+function rgxTokenTypeFlat(value: unknown): RGXTokenTypeFlat
 ```
-Determines the flat type of a given RGX token (`no-op`, `literal`, `native`, `convertible`, or `array`). The `array` type represents any array of RGX tokens, regardless of the types of the individual tokens within the array.
+Determines the flat type of a given RGX token value (`no-op`, `literal`, `native`, `convertible`, or `array`) or throws an error if the value is not a valid RGX token. The `array` type represents any array of RGX tokens, regardless of the types of the individual tokens within the array.
 
 If you narrow the result of this function to something more specific, you can then convert these string literals into their corresponding token types using the `RGXTokenFromType` utility type or `rgxTokenFromType` function.
 
@@ -346,7 +346,7 @@ if (type === 'array') {
 ```
 
 #### Parameters
-  - `value` (`RGXToken`): The RGX token to check.
+  - `value` (`unknown`): The value to check.
 
 #### Returns
 - `RGXTokenTypeFlat`: The flat type of the RGX token.

package/dist/typeGuards.d.ts

@@ -9,8 +9,8 @@ export declare function isRGXConvertibleToken(value: unknown): value is t.RGXCon
 export declare function assertRGXConvertibleToken(value: unknown): asserts value is t.RGXConvertibleToken;
 export declare function isRGXArrayToken(value: unknown): value is t.RGXToken[];
 export declare function assertRGXArrayToken(value: unknown): asserts value is t.RGXToken[];
-export declare function rgxTokenTypeFlat(value: t.RGXToken): t.RGXTokenTypeFlat;
-export declare function rgxTokenType(value: t.RGXToken): t.RGXTokenType;
+export declare function rgxTokenTypeFlat(value: unknown): t.RGXTokenTypeFlat;
+export declare function rgxTokenType(value: unknown): t.RGXTokenType;
 export declare function rgxTokenFromType<T extends t.RGXTokenTypeGuardInput>(type: T, value: t.RGXToken): t.RGXTokenFromType<T>;
 export declare function rgxTokenTypeToFlat(type: t.RGXTokenType): t.RGXTokenTypeFlat;
 export declare function rgxTokenTypeGuardInputToFlat(type: t.RGXTokenTypeGuardInput): t.RGXTokenTypeFlat | null;

package/dist/typeGuards.js

@@ -120,21 +120,16 @@ function rgxTokenTypeFlat(value) {
         return 'native';
     if (isRGXConvertibleToken(value))
         return 'convertible';
-    if (Array.isArray(value))
+    if (isRGXArrayToken(value))
         return 'array';
-    // Ignoring this line since it should be impossible to reach if the types are correct, but we need it to satisfy the return type
-    /* istanbul ignore next */
     throw new e.RGXInvalidTokenError("Invalid RGX token", null, value);
 }
 function rgxTokenType(value) {
     const flatType = rgxTokenTypeFlat(value);
     if (flatType !== 'array')
         return flatType;
-    if (flatType === 'array')
+    else
         return value.map(rgxTokenType);
-    // Ignoring this line since it should be impossible to reach if the types are correct, but we need it to satisfy the return type
-    /* istanbul ignore next */
-    throw new e.RGXInvalidTokenError("Invalid RGX token", null, value);
 }
 function rgxTokenFromType(type, value) {
     // Ignoring this line because the function is entirely a TypeScript utility that doesn't need to be tested at runtime.

package/package.json

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