feat: export token types

README.md

@@ -249,7 +249,7 @@ const parsed = typeFlag(
             if (stopParsing) {
                 return true
             }
-            const isArgument = type === 'argument'
+            const isArgument = type === TokenType.Argument
             if (isArgument) {
                 stopParsing = isArgument
                 return stopParsing
@@ -447,7 +447,7 @@ Type:
 type Options = {
     // Callback to skip parsing on certain argv tokens
     ignore?: (
-        type: 'known-flag' | 'unknown-flag' | 'argument',
+        type: TokenType,
         flagOrArgv: string,
         value: string | undefined,
     ) => boolean | void

src/index.ts

@@ -1,5 +1,6 @@
 export { typeFlag } from './type-flag';
 export { getFlag } from './get-flag';
+export { TokenType } from './types';
 export type {
 	TypeFlag,
 	TypeFlagOptions,

src/type-flag.ts

@@ -5,9 +5,7 @@ import type {
 	TypeFlagOptions,
 } from './types';
 import {
-	KNOWN_FLAG,
-	UNKNOWN_FLAG,
-	ARGUMENT,
+	TokenType
 } from './types';
 import {
 	hasOwn,
@@ -59,7 +57,7 @@ export const typeFlag = <Schemas extends Flags>(
 			const isKnownFlag = hasOwn(flagRegistry, name);
 			if (
 				ignore?.(
-					isKnownFlag ? KNOWN_FLAG : UNKNOWN_FLAG,
+					isKnownFlag ? TokenType.KnownFlag : TokenType.UnknownFlag,
 					name,
 					explicitValue,
 				)
@@ -103,7 +101,7 @@ export const typeFlag = <Schemas extends Flags>(
 		},
 
 		onArgument: (args, index, isEoF) => {
-			if (ignore?.(ARGUMENT, argv[index[0]])) {
+			if (ignore?.(TokenType.Argument, argv[index[0]])) {
 				return;
 			}
 

src/types.ts

@@ -110,18 +110,20 @@ export type TypeFlag<Schemas extends Flags> = ParsedFlags<{
 	[flag in keyof Schemas]: InferFlagType<Schemas[flag]>;
 }>;
 
-export const KNOWN_FLAG = 'known-flag';
-export const UNKNOWN_FLAG = 'unknown-flag';
-export const ARGUMENT = 'argument';
+export enum TokenType {
+	KnownFlag,
+	UnknownFlag,
+	Argument,
+};
 
 type IgnoreFunction = {
 	(
-		type: typeof ARGUMENT,
+		type: TokenType.Argument,
 		argvElement: string,
 	): boolean | void;
 
 	(
-		type: typeof KNOWN_FLAG | typeof UNKNOWN_FLAG,
+		type: TokenType.KnownFlag | TokenType.UnknownFlag,
 		flagName: string,
 		flagValue: string | undefined,
 	): boolean | void;

tests/specs/type-flag.ts

@@ -1,5 +1,5 @@
 import { testSuite, expect } from 'manten';
-import { typeFlag, type Flags } from '#type-flag';
+import { typeFlag, TokenType, type Flags } from '#type-flag';
 
 export default testSuite(({ describe }) => {
 	describe('type-flag', ({ describe }) => {
@@ -467,7 +467,7 @@ export default testSuite(({ describe }) => {
 						argv,
 						{
 							ignore: (type, flagName) => (
-								type === 'known-flag'
+								type === TokenType.KnownFlag
 								&& flagName === 'string'
 							),
 						},
@@ -505,7 +505,7 @@ export default testSuite(({ describe }) => {
 						},
 						argv,
 						{
-							ignore: type => type === 'unknown-flag',
+							ignore: type => type === TokenType.UnknownFlag,
 						},
 					);
 
@@ -538,7 +538,7 @@ export default testSuite(({ describe }) => {
 									return true;
 								}
 
-								const isArgument = type === 'argument';
+								const isArgument = type === TokenType.Argument;
 								if (isArgument) {
 									ignore = isArgument;
 									return isArgument;
@@ -575,7 +575,7 @@ export default testSuite(({ describe }) => {
 						},
 						argv,
 						{
-							ignore: (type, value) => (type === 'argument' && value === '--'),
+							ignore: (type, value) => (type === TokenType.Argument && value === '--'),
 						},
 					);