Merge pull request #7 from HarryPeach/dev

Added .getText() and .getFrame(), and new tests

README.md

@@ -2,7 +2,7 @@
 
 > Simple terminal spinners for Deno 🦕
 
-`Version 0.3.0`
+`Version 0.4.0`
 
 ![](https://github.com/HarryPeach/kia/workflows/CI/badge.svg)
 
@@ -15,7 +15,7 @@
 
 ```typescript
 
-import Kia from "https://deno.land/x/kia@0.3.0/mod.ts";
+import Kia from "https://deno.land/x/kia@0.4.0/mod.ts";
 
 // Just a function to async sleep
 function sleep(ms: number) {
@@ -156,12 +156,18 @@ Stops the spinner and holds it in a static state. Returns the instance.
 
 Renders the next frame of the spinner when it is stopped (i.e. can only be run after .stopAndPersist()).
 
+#### .getText()
+Returns the current text of the spinner
+
+#### .getFrame()
+Returns the current spinner frame
+
 ### forPromise(action, text)
 
 ### forPromise(action, options)
 
 ```typescript
-import { forPromise } from "https://deno.land/x/kia@0.3.0/mod.ts";
+import { forPromise } from "https://deno.land/x/kia@0.4.0/mod.ts";
 
 forPromise(
 	async () => {

egg.json

@@ -1,7 +1,7 @@
 {
 	"name": "kia",
 	"description": "Simple terminal spinners for Deno 🦕",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"unstable": false,
 	"entry": "/mod.ts",
 	"repository": "https://github.com/HarryPeach/kia",

kia.test.ts

@@ -1,4 +1,4 @@
-import Kia, { forPromise } from "./mod.ts";
+import Kia, { forPromise, Spinners } from "./mod.ts";
 import { assertThrows } from "https://deno.land/[email protected]/testing/asserts.ts";
 import { expect } from "https://deno.land/x/expect/mod.ts";
 class TestWriter implements Deno.WriterSync {
@@ -145,3 +145,16 @@ Deno.test("hidden cursor is returned", () => {
 			.includes("\x1b[?25h")
 	).toBe(true);
 });
+
+Deno.test("getFrame gets the correct frame", async () => {
+	const testWriter = new TestWriter();
+	const kia = new Kia({writer: testWriter, spinner: Spinners.windows});
+	expect(kia.getFrame()).toBe("/");
+});
+
+Deno.test("getText gets the correct text", async () => {
+	const TEST_TEXT = "This is sample text";
+	const testWriter = new TestWriter();
+	const kia = new Kia({writer: testWriter, text: TEST_TEXT});
+	expect(kia.getText()).toEqual(TEST_TEXT);
+});

kia.ts

@@ -66,6 +66,7 @@ export default class Kia {
 		if (this.spinning) {
 			this.stop();
 		}
+
 		this.spinning = true;
 
 		if (text) this.set(text);
@@ -188,6 +189,20 @@ export default class Kia {
 		return this.spinning;
 	}
 
+	/**
+	 * Returns the current spinner frame
+	 */
+	getFrame(): string {
+		return this.options.spinner.frames[this.currentFrame];
+	}
+
+	/**
+	 * Gets the current text
+	 */
+	getText(): string {
+		return this.options.text;
+	}
+
 	/**
 	 * Renders each frame of the spinner
 	 */