Merge pull request #30 from filefoxper/4.3.1

## v4.3.1 2022-04-25

Author: filefoxper

docs/api.md

@@ -113,10 +113,12 @@ The `Provider` set with `isRootProvider` can stop the finding.
 ```typescript
 export function useModel<T extends Model>(
     key: string| number| { new(): T },
+    defaultModel?:T,
 ):T;
 ```
 
 * key - the model name marked in customized object, the index value in customized array or the class of the finding model instance.
+* defaultModel - optional, provide a default model, when the useModel can not fetch model instance from parent Context, it will use the default one.
 
 It returns the first matched model instance.
 
@@ -154,4 +156,4 @@ export declare function useAgentEffect<S, T extends Model<S>=Model<S>>(
 
 returns void.
 
-Go to [tutorial](/tutorial?id=use-agent-effect) to see, how to use it.
+Go to [tutorial](/tutorial?id=use-agent-effect) to see, how to use it.

docs/changes.md

@@ -89,3 +89,7 @@
 ## v4.3.0 2022-04-06
 
 * [update] update for `[email protected]`.
+
+## v4.3.1 2022-04-25
+
+* [design] add the param defaultModel for API [useModel](/api?id=usemodel)

docs/zh/api.md

@@ -109,10 +109,12 @@ export function useModelProvider(
 ```typescript
 export function useModel<T extends Model>(
     key: string| number| { new(): T },
+    defaultModel?:T
 ):T;
 ```
 
 * key - 查询索引，如果当前作用域 Provider 或其父 Provider 中又包含当前 key 的对象模型实例集合，则获取最近一层相关的 key 对应的实例。key 可以是字符串，可以是数字，也可以是模型的 class 。
+* defaultModel - 可选，当 useModel 无法从父级 Context 获取模型实例时，会采用默认模型实例。
 
 如果查询失败，该方法会爆错，否则返回查询到的最近一个符合条件的模型实例。
 
@@ -151,4 +153,4 @@ export declare function useAgentEffect<S, T extends Model<S>=Model<S>>(
 
 该 API 无返回值。
 
-移步至[教程](/zh/tutorial?id=使用副作用)，看看如何使用该 API。
+移步至[教程](/zh/tutorial?id=使用副作用)，看看如何使用该 API。

docs/zh/changes.md

@@ -89,3 +89,7 @@
 ## v4.3.0 2022-04-06
 
 * [update] 跟随 `[email protected]` 更新。
+
+## v4.3.1 2022-04-25
+
+* [新增] 为 API [useModel](/zh/api?id=usemodel) 添加第二个参数 defaultModel。

index.d.ts

@@ -36,8 +36,9 @@ export declare function useModelProvider(
 
 export declare function useModel<T extends Model>(
     key: string| number| { new(...args:any[]): T },
+    defaultModel?:T,
 ):T;
 
 export declare function useWeakSharing<
     S,
-    T extends Model<S> = Model<S>>(factory:Factory<S, T>):SharingRef<S, T>;
+    T extends Model<S> = Model<S>>(factory:Factory<S, T>):SharingRef<S, T>;

src/index.ts

@@ -237,6 +237,7 @@ function findModelBy(
 
 export function useModel<T extends Model>(
   key: string| number| { new(...args:any[]): T },
+  defaultModel?:T,
 ):T {
   const parent = useContext(ModelContext);
   const result = useMemo(() => {
@@ -245,10 +246,13 @@ export function useModel<T extends Model>(
     }
     return findModelBy(parent, ([, model]) => Object.getPrototypeOf(model).constructor === key);
   }, []) as T;
-  if (!result) {
+  if (result) {
+    return result;
+  }
+  if (!defaultModel) {
     throw new Error('Can not find the model.');
   }
-  return result;
+  return defaultModel;
 }
 
 export function useAgentEffect<S, T extends Model<S>=Model<S>>(