renamed createState

Author: bennobuilder

packages/core/src/state/public/createEnhancedState.ts

@@ -0,0 +1,37 @@
+import { defineConfig, removeProperties } from '@agile-ts/utils';
+import { shared } from '../../shared';
+import { EnhancedState } from '../state.enhanced';
+import { CreateStateConfigInterfaceWithAgile } from './index';
+
+/**
+ * Returns a newly created enhanced State.
+ *
+ * An enhanced State manages, like a normal State, a piece of Information
+ * that we need to remember globally at a later point in time.
+ * While providing a toolkit to use and mutate this piece of Information.
+ *
+ * The main difference to a normal State is however
+ * that an enhanced State provides a wider variety of inbuilt utilities (like a persist, undo, watch functionality)
+ * but requires a larger bundle size in return.
+ *
+ * You can create as many global enhanced States as you need.
+ *
+ * [Learn more..](https://agile-ts.org/docs/core/agile-instance/methods#createstate)
+ *
+ * @public
+ * @param initialValue - Initial value of the State.
+ * @param config - Configuration object
+ */
+export function createEnhancedState<ValueType = any>(
+  initialValue: ValueType,
+  config: CreateStateConfigInterfaceWithAgile = {}
+): EnhancedState<ValueType> {
+  config = defineConfig(config, {
+    agileInstance: shared,
+  });
+  return new EnhancedState<ValueType>(
+    config.agileInstance as any,
+    initialValue,
+    removeProperties(config, ['agileInstance'])
+  );
+}

packages/core/src/state/public/createState.ts

@@ -1,7 +1,8 @@
-import { defineConfig, removeProperties } from '@agile-ts/utils';
-import { shared } from '../../shared';
+import {
+  createEnhancedState,
+  CreateStateConfigInterfaceWithAgile,
+} from './index';
 import { EnhancedState } from '../state.enhanced';
-import { CreateStateConfigInterfaceWithAgile } from './index';
 
 /**
  * Returns a newly created enhanced State.
@@ -26,12 +27,5 @@ export function createState<ValueType = any>(
   initialValue: ValueType,
   config: CreateStateConfigInterfaceWithAgile = {}
 ): EnhancedState<ValueType> {
-  config = defineConfig(config, {
-    agileInstance: shared,
-  });
-  return new EnhancedState<ValueType>(
-    config.agileInstance as any,
-    initialValue,
-    removeProperties(config, ['agileInstance'])
-  );
+  return createEnhancedState(initialValue, config);
 }

packages/core/src/state/public/index.ts

@@ -2,6 +2,7 @@ import { CreateAgileSubInstanceInterface } from '../../shared';
 import { StateConfigInterface } from '../state';
 
 export * from './createState';
+export * from './createEnhancedState';
 export * from './createLightState';
 
 export interface CreateStateConfigInterfaceWithAgile