docs(State): align description of state.State.includes with actual …

…implementation (#48)
ui-router · May 9, 2017 · 1f2f74a · 1f2f74a
1 parent eee888d
commit 1f2f74a
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/state/stateObject.ts b/src/state/stateObject.ts
@@ -77,8 +77,11 @@ export class StateObject {
    */
   public data: any;
 
-  /** An array of strings of the parent States' names */
-  public includes: { [name: string] : boolean };
+  /** 
+   * An object containing the parent States' names as keys and 
+   * true as their values.
+   */
+  public includes: { [name: string]: boolean };
 
   /** Prototypally inherits from [[StateDeclaration.onExit]] */
   public onExit: TransitionStateHookFn;