From 1f2f74a11fe7286b234cc59def0b480a75ee7649 Mon Sep 17 00:00:00 2001 From: Robert Dey Date: Wed, 10 May 2017 01:25:52 +0200 Subject: [PATCH] docs(State): align description of `state.State.includes` with actual implementation (#48) --- src/state/stateObject.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/state/stateObject.ts b/src/state/stateObject.ts index 0062ef4e..2e016e85 100644 --- 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;