Merge pull request #11 from EGAMAGZ/development

Improved validations, error handling and code redability

Author: EGAMAGZ

README.md

@@ -39,7 +39,7 @@ Check the [JSR page for more details](https://jsr.io/@egamagz/paska-ovo).
 import { HistoricalCodes, PaskaOvo } from "@egamagz/paska-ovo";
 
 const paskaOvo = new PaskaOvo()
-  .addCode({
+  .addEasterEgg({
     code: HistoricalCodes.BarrelRoll,
     onFound: () => {
       //...
@@ -50,14 +50,14 @@ const paskaOvo = new PaskaOvo()
     duration: 1000,
     tag: "Barrel Roll"
   })
-  .addCode({
+  .addEasterEgg({
     code: HistoricalCodes.Konami,
     onFound: () => {
       // ...
     },
     tag: "Konami"
   })
-  .addCode({
+  .addEasterEgg({
     code: ["a", "w", "e", "s", "o", "m", "e"],
     onFound: () => {
       // ...

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@egamagz/paska-ovo",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "exports": "./mod.ts",
   "lock": false,
   "compilerOptions": {

example/package-lock.json

@@ -12,4 +12,4 @@ export default function Badge({ text, url, children }: Props) {
             {children} <span>{text}</span>
         </a>
     );
-}
+}

example/src/components/Badge.tsx

@@ -1,5 +1,5 @@
 import { useSignal, useSignalEffect } from "@preact/signals";
-import { PaskaOvo, HistoricalCodes } from "@/../../mod";
+import { PaskaOvo, HistoricalCodes, type EasterEgg } from "@/../../mod";
 import Title from "./Title";
 
 enum EasterEggStatus {
@@ -14,7 +14,14 @@ export default function EasterEgg() {
 
     useSignalEffect(() => {
         const paskaOvo = new PaskaOvo()
-            .addCode({
+		.addEasterEgg({
+			code: ["4", "1", "8"],
+			onFound: () => {
+				throw new Error("418 - I'm a teapot")
+			},
+			tag: "Example"
+		})
+            .addEasterEgg({
                 code: HistoricalCodes.BarrelRoll,
                 onFound: () => {
                     easterEggStatus.value = EasterEggStatus.BarrelRoll
@@ -25,28 +32,28 @@ export default function EasterEgg() {
                 duration: 1000,
                 tag: "Barrel Roll"
             })
-            .addCode({
+            .addEasterEgg({
                 code: HistoricalCodes.Konami,
                 onFound: () => {
                     easterEggStatus.value = easterEggStatus.peek() === EasterEggStatus.Konami ? EasterEggStatus.None : EasterEggStatus.Konami
                 },
                 tag: "Konami"
             })
-            .addCode({
+            .addEasterEgg({
                 code: ["up", "up", "down", "down", "left", "right", "left", "right", "b", "a", "c"],
                 onFound: () => {
                     alert("Nothing to show here... Sorry :(")
                 },
                 tag: "Konami+C"
             })
-            .addCode({
+            .addEasterEgg({
                 code: ["a", "w", "e", "s", "o", "m", "e"],
                 onFound: () => {
                     easterEggStatus.value = easterEggStatus.peek() === EasterEggStatus.Awesome ? EasterEggStatus.None : EasterEggStatus.Awesome
                 },
                 tag: "Awesome"
             })
-            .addCallback((easterEgg) => {
+            .addCallback((easterEgg: EasterEgg) => {
                 alert(`You found the easter egg: ${easterEgg.tag}`)
             });
 
@@ -62,4 +69,4 @@ export default function EasterEgg() {
             <Title showKonami={easterEggStatus.value === EasterEggStatus.Konami} />
         </div>
     );
-}
+}

example/src/components/EasterEgg.tsx

@@ -1,24 +1,33 @@
 /**
  * @module
  * This module contains historical codes used in the project.
- * 
  */
 
 /**
  * List of historical and important codes in video games.
- * */
+ */
 export const HistoricalCodes = {
-    /**
-     * Konami code. No one knows what it is.
-     * 
-     * */
-    Konami: ["Up", "Up", "Down", "Down", "Left", "Right", "Left", "Right", "b", "a"],
-    /**
-     * Iddqd code. Reference to the command used in Doom.
-     */
-    Iddqd: ["i", "d", "d", "q", "d"],
-    /**
-     * Barrel roll code. Reference to the phrase from Star Fox 64.
-     * */
-    BarrelRoll: ["Up", "Right", "Down", "Left"]
-};
+  /**
+   * Konami code. No one knows what it is.
+   */
+  Konami: [
+    "Up",
+    "Up",
+    "Down",
+    "Down",
+    "Left",
+    "Right",
+    "Left",
+    "Right",
+    "b",
+    "a",
+  ],
+  /**
+   * Iddqd code. Reference to the command used in Doom.
+   */
+  Iddqd: ["i", "d", "d", "q", "d"],
+  /**
+   * Barrel roll code. Reference to the phrase from Star Fox 64.
+   */
+  BarrelRoll: ["Up", "Right", "Down", "Left"],
+};