@rbxts/covenant 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/hooks.d.ts +9 -10
- package/src/hooks.luau +0 -1
package/package.json
CHANGED
package/src/hooks.d.ts
CHANGED
|
@@ -5,22 +5,21 @@ type AsyncResult<T = unknown> = {
|
|
|
5
5
|
errorMessage?: string;
|
|
6
6
|
};
|
|
7
7
|
export type Discriminator = Exclude<defined, number>;
|
|
8
|
-
type CovenantHook<T extends (...args: Array<any>) => defined> = (updateId: number, ...args: Parameters<T>) => ReturnType<T>;
|
|
9
8
|
export interface CovenantHooks {
|
|
10
|
-
useEvent:
|
|
11
|
-
useEventImmediately:
|
|
12
|
-
useComponentChange:
|
|
9
|
+
useEvent: <T extends Array<unknown>>(updateId: number, event: RBXScriptSignal<(...args: T) => void>) => T[];
|
|
10
|
+
useEventImmediately: <T extends Array<unknown>, TReturn extends defined>(updateId: number, event: RBXScriptSignal<(...args: T) => void>, callback: (...args: T) => TReturn) => TReturn[];
|
|
11
|
+
useComponentChange: <T extends defined>(updateId: number, component: Entity<T>) => {
|
|
13
12
|
entity: Entity;
|
|
14
13
|
state: T | undefined;
|
|
15
14
|
previousState: T | undefined;
|
|
16
|
-
}[]
|
|
17
|
-
useAsync:
|
|
18
|
-
useImperative:
|
|
15
|
+
}[];
|
|
16
|
+
useAsync: <T>(updateId: number, asnycFactory: () => T, dependencies: unknown[], discriminator: Discriminator) => AsyncResult<T>;
|
|
17
|
+
useImperative: <T extends defined>(updateId: number, dirtyFactory: (indicateUpdate: () => void) => {
|
|
19
18
|
value: T;
|
|
20
19
|
cleanup?: () => void;
|
|
21
|
-
}, dependencies: unknown[], discriminator: Discriminator) => T
|
|
22
|
-
useChange:
|
|
23
|
-
useInterval:
|
|
20
|
+
}, dependencies: unknown[], discriminator: Discriminator) => T;
|
|
21
|
+
useChange: (updateId: number, dependencies: unknown[], discriminator: Discriminator) => boolean;
|
|
22
|
+
useInterval: (updateId: number, seconds: number, trueOnInit: boolean, discriminator: Discriminator) => boolean;
|
|
24
23
|
}
|
|
25
24
|
interface CovenantHooksProps {
|
|
26
25
|
indicateUpdate: () => void;
|