diff --git a/packages/core/src/stateUtils.ts b/packages/core/src/stateUtils.ts index 65473e8f4c..d9330c4b3b 100644 --- a/packages/core/src/stateUtils.ts +++ b/packages/core/src/stateUtils.ts @@ -982,11 +982,6 @@ function areConfigurationsEqual( /** * https://www.w3.org/TR/scxml/#microstepProcedure - * - * @private - * @param transitions - * @param currentState - * @param mutConfiguration */ export function microstep< TContext extends MachineContext, diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts index 63abc8c884..3ac5dda79c 100644 --- a/packages/core/src/types.ts +++ b/packages/core/src/types.ts @@ -23,6 +23,9 @@ export type HomomorphicOmit = { }; /** + * + * @remarks + * * `T | unknown` reduces to `unknown` and that can be problematic when it comes to contextual typing. * It especially is a problem when the union has a function member, like here: * @@ -284,7 +287,10 @@ export interface StateValueMap { /** * The string or object representing the state value relative to the parent state node. * + * @remarks + * * - For a child atomic state node, this is a string, e.g., `"pending"`. + * * - For complex state nodes, this is an object, e.g., `{ success: "someChildState" }`. */ export type StateValue = string | StateValueMap; @@ -834,9 +840,6 @@ export interface StateNodeConfig< TGuard, TDelay >; - /** - * @private - */ parent?: StateNode; /** * The meta data associated with this state node, which will be returned in State instances.