nanosplash 3.0.9 → 3.1.1

package/src/ts/types/NanosplashInterface.ts

@@ -1,7 +1,26 @@
 import { DOMSelector, UTCInteger } from './Types'
 
 export interface NanosplashInterface {
+	/**
+	 * # Show
+	 * Display Nanosplash inside the window.
+	 * @param {string | undefined} text Optional text
+	 * @param {string | Element | undefined} inside Optional element reference
+	 * @returns {number | null} The internal ID of the created Nanosplash.
+	 */
 	show(text?: string, inside?: DOMSelector | HTMLElement): UTCInteger | null
-	hide(id?: UTCInteger): void
-	hideAll(): void
+	/**
+	 * # Hide
+	 * Remove Nanosplash in multiple ways depending on the passed argument.
+	 * - Pass ID: Remove specific.
+	 * - Pass '*': Remove all in window.
+	 * - Pass nothing: Remove in FIFO order.
+	 * @param id The internal ID, an asterisk, or nothing.
+	 */
+	hide(id?: UTCInteger | '*'): void
+	/**
+	 * # Version
+	 * The current version of Nanosplash.
+	 */
+	version: string
 }

package/src/ts/types/Types.ts

@@ -1,6 +1,7 @@
 import { NanosplashInterface } from './NanosplashInterface'
 
-export type UTCInteger = number
+export type Integer = number
+export type UTCInteger = Integer
 export type DOMSelector = string
 export type ElementReference = DOMSelector | Element
 

package/tests/Nanosplash.spec.ts

@@ -1,16 +1,20 @@
 import { describe, it, test, expect, beforeEach } from 'vitest'
-import { useNs } from '../src/ts/Nanosplash'
 import { JSDOM } from 'jsdom'
+import { NanosplashInterface } from '../src/ts/types/NanosplashInterface'
 
-let ns
+let dom = new JSDOM()
+let document: Document | null = null
+let ns: NanosplashInterface | null = null
 
-beforeEach(() => {
-	const dom = new JSDOM()
+async function updateGlobals() {
+	dom = new JSDOM()
 	// @ts-ignore
 	globalThis.window = dom.window
-	globalThis.document = window.document
-	globalThis.window.ns = ns = useNs()
-})
+	document = globalThis.document = dom.window.document
+	ns = globalThis.window.ns = (await import('../src/ts/Nanosplash')).useNs()
+}
+
+beforeEach(updateGlobals)
 
 describe('Nanosplash API', () => {
 	it('should be defined', () => {
@@ -25,10 +29,6 @@ describe('Nanosplash API', () => {
 		expect(window.ns.hide).toBeDefined()
 	})
 
-	it('should have the "hideAll" method', () => {
-		expect(window.ns.hideAll).toBeDefined()
-	})
-
 	it('should have the global instance', () => {
 		expect(window.ns).toBe(ns)
 	})