@chocbite/ts-lib-state 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -360,8 +360,12 @@ declare abstract class StateBase<RT, WT, REL extends Option<StateRelated>, RRT e
  * @template RT - The type of the state’s value when read.
  * @template REL - The type of related states, defaults to an empty object.*/
 interface StateResourceOwnerREA<RT, WT, REL extends Option<StateRelated>> {
+    /**Updates the resource and fulfills all promises for value
+     * @param update if true, also updates the buffer and notifies subscribers, otherwise only fulfills the promises for single gets*/
     update_single(value: Result<RT, string>, update?: boolean): void;
+    /**Updates the resource subscribers and buffer with the given value*/
     update_resource(value: Result<RT, string>): void;
+    /**Gets the current buffer value*/
     get buffer(): Result<RT, string> | undefined;
     get state(): State<RT, WT, REL>;
     get read_only(): StateREA<RT, REL, WT>;
@@ -415,7 +419,10 @@ type StateResourceFuncREA<RT, REL extends Option<StateRelated> = Option<{}>, WT
  * @template WT - The type which can be written to the state.
  * @template REL - The type of related states, defaults to an empty object.*/
 interface StateResourceOwnerREAWA<RT, WT, REL extends Option<StateRelated>> {
+    /**Updates the resource and fulfills all promises for value
+     * @param update if true, also updates the buffer and notifies subscribers, otherwise only fulfills the promises for single gets*/
     update_single(value: Result<RT, string>, update?: boolean): void;
+    /**Updates the resource subscribers and buffer with the given value*/
     update_resource(value: Result<RT, string>): void;
     get buffer(): Result<RT, string> | undefined;
     get state(): State<RT, WT, REL>;
@@ -479,7 +486,10 @@ type StateResourceFuncREAWA<RT, REL extends Option<StateRelated> = Option<{}>, W
  * @template RT - The type of the state’s value when read.
  * @template REL - The type of related states, defaults to an empty object.*/
 interface StateResourceOwnerROA<RT, WT, REL extends Option<StateRelated>> {
+    /**Updates the resource and fulfills all promises for value
+     * @param update if true, also updates the buffer and notifies subscribers, otherwise only fulfills the promises for single gets*/
     update_single(value: ResultOk<RT>, update?: boolean): void;
+    /**Updates the resource subscribers and buffer with the given value*/
     update_resource(value: ResultOk<RT>): void;
     get buffer(): ResultOk<RT> | undefined;
     get state(): State<RT, WT, REL>;
@@ -1427,4 +1437,4 @@ declare const state: {
     from_ws: <RT, WT = RT, REL extends _chocbite_ts_lib_result.Option<StateRelated> = _chocbite_ts_lib_result.Option<{}>>(this: void, init: RT, setter?: ((value: WT, state: OwnerWS$6<RT, _chocbite_ts_lib_result.Result<RT, string>, WT, REL>, old?: _chocbite_ts_lib_result.Result<RT, string> | undefined) => _chocbite_ts_lib_result.Result<void, string>) | true, helper?: StateHelper<WT, REL>) => StateSyncRESWS<RT, WT, REL>;
 };
 
-export { type State, type StateArray, type StateArrayREA, type StateArrayREAWA, type StateArrayREAWS, type StateArrayRES, type StateArrayRESWA, type StateArrayRESWS, type StateArrayROA, type StateArrayROAWA, type StateArrayROAWS, type StateArrayROS, type StateArrayROSWA, type StateArrayROSWS, type StateArrayRead, StateArrayReadType, type StateArraySyncRES, type StateArraySyncRESWS, type StateArraySyncROS, type StateArraySyncROSWS, type StateArrayWrite, type StateCollectedREA, type StateCollectedRES, type StateCollectedROA, type StateCollectedROS, type StateDelayedREA, type StateDelayedREAWA, type StateDelayedREAWS, type StateDelayedROA, type StateDelayedROAWA, type StateDelayedROAWS, StateEnumHelper, type StateEnumRelated, type StateInferResult, type StateInferSub, type StateInferType, type StateLazyRES, type StateLazyRESWS, type StateLazyROS, type StateLazyROSWS, StateNumberHelper, type StateNumberRelated, type StateProxyREA, type StateProxyREAWA, type StateProxyREAWS, type StateProxyRES, type StateProxyRESWA, type StateProxyRESWS, type StateProxyROA, type StateProxyROAWA, type StateProxyROAWS, type StateProxyROS, type StateProxyROSWA, type StateProxyROSWS, type StateREA, type StateREAWA, type StateREAWS, type StateRES, type StateRESWA, type StateRESWS, type StateROA, type StateROAWA, type StateROAWS, type StateROS, type StateROSWA, type StateROSWS, type StateResourceFuncREA, type StateResourceFuncREAWA, type StateResourceFuncROA, StateResourceREA, StateResourceREAWA, StateResourceROA, StateStringHelper, type StateStringRelated, type StateSub, type StateSyncRES, type StateSyncRESWS, type StateSyncROS, type StateSyncROSWS, state };
+export { type State, type StateArray, type StateArrayREA, type StateArrayREAWA, type StateArrayREAWS, type StateArrayRES, type StateArrayRESWA, type StateArrayRESWS, type StateArrayROA, type StateArrayROAWA, type StateArrayROAWS, type StateArrayROS, type StateArrayROSWA, type StateArrayROSWS, type StateArrayRead, StateArrayReadType, type StateArraySyncRES, type StateArraySyncRESWS, type StateArraySyncROS, type StateArraySyncROSWS, type StateArrayWrite, type StateCollectedREA, type StateCollectedRES, type StateCollectedROA, type StateCollectedROS, type StateDelayedREA, type StateDelayedREAWA, type StateDelayedREAWS, type StateDelayedROA, type StateDelayedROAWA, type StateDelayedROAWS, StateEnumHelper, type StateEnumRelated, type StateInferResult, type StateInferSub, type StateInferType, type StateLazyRES, type StateLazyRESWS, type StateLazyROS, type StateLazyROSWS, StateNumberHelper, type StateNumberRelated, type StateProxyREA, type StateProxyREAWA, type StateProxyREAWS, type StateProxyRES, type StateProxyRESWA, type StateProxyRESWS, type StateProxyROA, type StateProxyROAWA, type StateProxyROAWS, type StateProxyROS, type StateProxyROSWA, type StateProxyROSWS, type StateREA, type StateREAWA, type StateREAWS, type StateRES, type StateRESWA, type StateRESWS, type StateROA, type StateROAWA, type StateROAWS, type StateROS, type StateROSWA, type StateROSWS, type StateResourceFuncREA, type StateResourceFuncREAWA, type StateResourceFuncROA, StateResourceREA, StateResourceREAWA, StateResourceROA, StateStringHelper, type StateStringRelated, type StateSub, type StateSyncRES, type StateSyncRESWS, type StateSyncROS, type StateSyncROSWS, state as default, state };

package/dist/index.js

@@ -3690,9 +3690,11 @@ var state = {
   err_ws: STATE_SYNC.res_ws.err,
   from_ws: STATE_SYNC.res_ws.ok
 };
+var index_default = state;
 export {
   StateEnumHelper,
   StateNumberHelper,
   StateStringHelper,
+  index_default as default,
   state
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chocbite/ts-lib-state",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "State management library for TypeScript",
   "author": "chocolateandmilkwin",
   "license": "MIT",