@yaasl/core 0.9.1 → 0.9.2

package/dist/@types/base/Stateful.d.ts

@@ -1,6 +1,7 @@
 type Callback<Value> = (value: Value, previous: Value) => void;
 export declare class Stateful<Value = unknown> {
     protected value: Value;
+    /** Promise that resolves when the states initialization was finished. */
     didInit: PromiseLike<void> | boolean;
     private listeners;
     constructor(value: Value);

package/dist/@types/base/createAtom.d.ts

@@ -13,8 +13,11 @@ export interface AtomConfig<Value, R extends Reducers<Value> = Reducers<Value>>
     reducers?: R;
 }
 export declare class Atom<Value = unknown, R extends Reducers<Value> = Reducers<Value>> extends Stateful<Value> {
+    /** Default value of the atom. */
     readonly defaultValue: Value;
+    /** Identifier of the atom. */
     readonly name: string;
+    /** Actions that can be used to set the atom's value. */
     readonly actions: Actions<Value, R>;
     constructor({ defaultValue, name, effects, reducers, }: AtomConfig<Value, R>);
     /** Set the value of the atom.
@@ -32,11 +35,5 @@ export declare class Atom<Value = unknown, R extends Reducers<Value> = Reducers<
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
 export declare const createAtom: <Value, R extends Reducers<Value> = Reducers<Value>>(config: AtomConfig<Value, R>) => Atom<Value, R>;

package/dist/cjs/base/Stateful.js

@@ -4,6 +4,7 @@ exports.Stateful = void 0;
 class Stateful {
     constructor(value) {
         this.value = value;
+        /** Promise that resolves when the states initialization was finished. */
         this.didInit = false;
         this.listeners = new Set();
     }

package/dist/cjs/base/createAtom.js

@@ -37,12 +37,6 @@ exports.Atom = Atom;
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
 const createAtom = (config) => new Atom(config);
 exports.createAtom = createAtom;

package/dist/mjs/base/Stateful.js

@@ -1,6 +1,7 @@
 export class Stateful {
     constructor(value) {
         this.value = value;
+        /** Promise that resolves when the states initialization was finished. */
         this.didInit = false;
         this.listeners = new Set();
     }

package/dist/mjs/base/createAtom.js

@@ -33,11 +33,5 @@ export class Atom extends Stateful {
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
 export const createAtom = (config) => new Atom(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaasl/core",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "yet another atomic store library (vanilla-js)",
   "author": "PrettyCoffee",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "validate": "run-s lint test build"
   },
   "dependencies": {
-    "@yaasl/utils": "0.9.1"
+    "@yaasl/utils": "0.9.2"
   },
   "eslintConfig": {
     "extends": [