Skip to content

Commit 1f2f74a

Browse files
RobYedchristopherthielen
authored andcommitted
docs(State): align description of state.State.includes with actual implementation (#48)
1 parent eee888d commit 1f2f74a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/state/stateObject.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,11 @@ export class StateObject {
7777
*/
7878
public data: any;
7979

80-
/** An array of strings of the parent States' names */
81-
public includes: { [name: string] : boolean };
80+
/**
81+
* An object containing the parent States' names as keys and
82+
* true as their values.
83+
*/
84+
public includes: { [name: string]: boolean };
8285

8386
/** Prototypally inherits from [[StateDeclaration.onExit]] */
8487
public onExit: TransitionStateHookFn;

0 commit comments

Comments
 (0)