Skip to content

Commit cafc343

Browse files
refactor: improve documentation for UnityProvider interface for better clarity
1 parent 558c964 commit cafc343

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

module/source/types/unity-provider.d.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
import { UnityConfig } from "./unity-config";
22
import { UnityInstance } from "./unity-instance";
33

4+
/**
5+
* The UnityProvider interface defines the properties and methods required to
6+
* create and manage a Unity instance within a React application. It is used for
7+
* internal management of the Unity instance and provides methods to interact
8+
* with the Unity instance, such as setting the loading progression, handling
9+
* fullscreen requests, and managing the Unity instance's state.
10+
*/
411
type UnityProvider = Pick<
512
UnityConfig,
613
| "loaderUrl"

0 commit comments

Comments
 (0)