feat: Exposes isScormInteractionType guard

src/constrainedStrings/scormInteractionType/readme.md

@@ -2,7 +2,7 @@
 
 [Back to root readme.md](../../../readme.md)
 
-This function can be used to check the type of the input is a valid SCORM interaction type as shown in the example below. It should only throw `rulr.InvalidScormInteractionTypeError`. This is a little convenience rule for everyone trying to improve the world's training using [SCORM](https://scorm.com/) or the [xAPI](https://github.com/adlnet/xAPI-Spec), this package might not exist without these people.
+This function uses `rulr.isScormInteractionType` to check the input is a valid SCORM interaction type as shown in the example below. It should only throw `rulr.InvalidScormInteractionTypeError`. This is a little convenience rule for everyone trying to improve the world's training using [SCORM](https://scorm.com/) or the [xAPI](https://github.com/adlnet/xAPI-Spec), this package might not exist without these people.
 
 ```ts
 import * as rulr from 'rulr'

src/constrainedStrings/scormInteractionType/scormInteractionType.ts

@@ -1,5 +1,5 @@
 import { BaseError } from 'make-error'
-import { enumerated } from '../../valueRules/enum/enum'
+import { isEnum } from '../../valueRules/enum/enum'
 
 export class InvalidScormInteractionTypeError extends BaseError {
 	constructor() {
@@ -22,10 +22,13 @@ export enum ScormInteractionType {
 	Other = 'other',
 }
 
+export function isScormInteractionType(input: unknown): input is ScormInteractionType {
+	return isEnum(ScormInteractionType, input)
+}
+
 export function scormInteractionType(input: unknown) {
-	try {
-		return enumerated(ScormInteractionType)(input)
-	} catch (err) {
-		throw new InvalidScormInteractionTypeError()
+	if (isScormInteractionType(input)) {
+		return input
 	}
+	throw new InvalidScormInteractionTypeError()
 }

src/lib.ts

@@ -46,6 +46,7 @@ export {
 } from './constrainedStrings/mongoId/mongoId'
 export {
 	scormInteractionType,
+	isScormInteractionType,
 	ScormInteractionType,
 	InvalidScormInteractionTypeError,
 } from './constrainedStrings/scormInteractionType/scormInteractionType'