docs(core): add TSDoc for isExecutableToken

freshgum-bubbles · May 30, 2024 · f33b398 · f33b398
1 parent c581309
commit f33b398
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/executable-token.class.mts b/src/executable-token.class.mts
@@ -42,6 +42,12 @@ export abstract class ExecutableToken<T> extends Token<T> {
   readonly [EXECUTABLE_TOKEN] = ExecutableTokenStamp.Generic;
 }
 
+/**
+ * Determine whether a given value is of type {@link ExecutableToken}.
+ *
+ * @param x - The parameter to test.
+ * @returns Whether the given value is an executable token.
+ */
 export function isExecutableToken(x: any): x is ExecutableToken<unknown> {
   return x != null && x[EXECUTABLE_TOKEN] == ExecutableTokenStamp.Generic;
 }