feat(hooks): pass optional type generic to useScene

README.md

@@ -172,6 +172,14 @@ const scene = useScene();
 > [!WARNING]
 > Don't use this hook if you start multiple Scenes.
 
+To specify a Scene class in TypeScript:
+
+```ts
+class MyScene extends Phaser.Scene {}
+
+const scene = useScene<typeof MyScene>();
+```
+
 ## Release
 
 Release is automated with [Release Please](https://github.com/googleapis/release-please).

src/helpers/scene.test.ts

@@ -8,8 +8,15 @@ afterEach(() => {
   setScene(undefined as unknown as Scene);
 });
 
-it('sets and gets scene', () => {
-  expect(getScene()).toEqual(undefined);
-  expect(setScene(scene)).toEqual(undefined);
-  expect(getScene()).toEqual(scene);
+describe('getScene', () => {
+  it('gets scene', () => {
+    expect(getScene<typeof scene>()).toEqual(undefined);
+  });
+});
+
+describe('setScene', () => {
+  it('sets scene', () => {
+    expect(setScene(scene)).toEqual(undefined);
+    expect(getScene()).toEqual(scene);
+  });
 });

src/helpers/scene.ts

@@ -2,8 +2,8 @@ import type { Scene } from 'phaser';
 
 let _scene: Scene;
 
-export function getScene() {
-  return _scene;
+export function getScene<Type = Scene>() {
+  return _scene as Type;
 }
 
 export function setScene(scene: Scene) {

src/hooks/useScene.test.ts

@@ -15,3 +15,7 @@ it('returns scene', () => {
   expect(useScene()).toEqual(scene);
   expect(mockedGetScene).toHaveBeenCalledTimes(1);
 });
+
+it('returns undefined', () => {
+  expect(useScene<undefined>()).toEqual(undefined);
+});

src/hooks/useScene.ts

@@ -1,3 +1,5 @@
+import type { Scene } from 'phaser';
+
 import { getScene } from '../helpers';
 
 /**
@@ -7,6 +9,6 @@ import { getScene } from '../helpers';
  *
  * @returns Phaser.Scene
  */
-export function useScene() {
-  return getScene();
+export function useScene<Type = Scene>() {
+  return getScene<Type>();
 }

src/types/utils.ts

@@ -1,3 +1,3 @@
-export type RecursivePartial<T> = {
-  [P in keyof T]?: RecursivePartial<T[P]>;
+export type RecursivePartial<Type> = {
+  [Property in keyof Type]?: RecursivePartial<Type[Property]>;
 };