mobx-keystone - npm Package Compare versions

Comparing version 0.48.3 to 0.48.4

dist/model/BaseModel.d.ts

@@ -26,4 +26,6 @@ import { O } from "ts-toolbelt";
  *
- * @typeparam Data Data type.
+ * @typeparam PropsData Props data type.
  * @typeparam CreationData Creation data type.
+ * @typeparam InstanceData Instace data type.
+ * @typeparam InstanceCreationData Instance creation data type.
  */
@@ -30,0 +32,0 @@ export declare abstract class BaseModel<PropsData extends {

dist/model/Model.d.ts

@@ -27,3 +27,3 @@ import { AnyModel, BaseModel, ModelClass } from "./BaseModel";
  * @typeparam TProps New model properties type.
- * @typeparam TBaseModel Base class type.
+ * @typeparam TBaseModelClass Base class type.
  * @param baseModel Base model type.
@@ -30,0 +30,0 @@ * @param modelProps Model properties.

dist/ref/core.d.ts

@@ -12,3 +12,3 @@ import { ObservableSet } from "mobx";
 /**
- * Reference resolve valude changed hook type.
+ * Type for the callback called when a reference resolved value changes.
  */
@@ -15,0 +15,0 @@ export declare type RefOnResolvedValueChange<T extends object> = (ref: Ref<T>, newValue: T | undefined, oldValue: T | undefined) => void;

dist/typeChecking/maybe.d.ts

@@ -11,3 +11,3 @@ import { AnyType, IdentityType } from "./schemas";
  *
- * @typeparam S Type.
+ * @typeparam T Type.
  * @param baseType Type.
@@ -26,3 +26,3 @@ * @returns
  *
- * @typeparam S Type.
+ * @typeparam T Type.
  * @param type Type.
@@ -29,0 +29,0 @@ * @returns

dist/typeChecking/ref.d.ts

@@ -12,3 +12,3 @@ import { Ref } from "../ref/Ref";
  *
- * @typeparam M Model type.
+ * @typeparam O Object or model type.
  * @returns
@@ -15,0 +15,0 @@ */

dist/typeChecking/tProp.d.ts

@@ -56,3 +56,2 @@ import { MaybeOptionalModelProp, ModelPropOptions, OnlyPrimitives, OptionalModelProp } from "../model/prop";
  * @typeparam TType Type checker type.
- *
  * @param type Type checker.
@@ -76,3 +75,2 @@ * @param defaultFn Default value generator function.
  * @typeparam TType Type checker type.
- *
  * @param type Type checker.
@@ -94,3 +92,2 @@ * @param defaultValue Default value generator function.
  * @typeparam TType Type checker type.
- *
  * @param type Type checker.
@@ -97,0 +94,0 @@ * @param options Model property options.

package.json

 {
   "name": "mobx-keystone",
-  "version": "0.48.3",
+  "version": "0.48.4",
   "description": "A MobX powered state management solution based on data trees with first class support for Typescript, snapshots, patches and much more",
@@ -41,4 +41,3 @@ "keywords": [
     "test:perf:run": "cd perf_bench && export NODE_ENV=production && /usr/bin/time node --expose-gc --require ts-node/register ./report.ts",
-    "fix-tsdocs": "shx rm -rf ../../node_modules/typedoc/node_modules/typescript",
-    "build-docs": "shx rm -rf ../site/public/api && typedoc --options ./typedocconfig.js",
+    "build-docs": "shx rm -rf ../site/public/api && typedoc --options ./typedocconfig.js src/index.ts",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\""
@@ -57,3 +56,3 @@ },
     "tsdx": "^0.14.1",
-    "typedoc": "^0.19.1",
+    "typedoc": "beta",
     "typescript": "^4.0.2"
@@ -60,0 +59,0 @@ },

README.md

@@ -0,0 +0,0 @@ # mobx-keystone

No alert changes

Improved metrics

Lines of code

33111

increased by0.07%

Worsened metrics

Total package byte prevSize

4163925

decreased by-2.75%

No dependency changes