@chocbite/ts-lib-state 1.0.1 → 1.0.3

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>;
@@ -552,6 +562,8 @@ interface StateNumberRelated extends StateRelated {
     max?: number;
     unit?: string;
     decimals?: number;
+    step?: number;
+    start?: number;
 }
 declare class StateNumberHelper implements StateNumberRelated, StateHelper<number, OptionSome<StateNumberRelated>> {
     min: number | undefined;

package/package.json

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