|
| 1 | +--- |
| 2 | +title: Config |
| 3 | +sidebar_position: 16 |
| 4 | +--- |
| 5 | +> **@types** [IPublicModelEngineConfig](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/engine-config.ts)<br/> |
| 6 | +> **@since** v1.1.3 |
| 7 | +
|
| 8 | +## 方法 |
| 9 | +### has |
| 10 | + |
| 11 | +判断指定 key 是否有值 |
| 12 | + |
| 13 | +```typescript |
| 14 | +/** |
| 15 | + * 判断指定 key 是否有值 |
| 16 | + * check if config has certain key configed |
| 17 | + * @param key |
| 18 | + * @returns |
| 19 | + */ |
| 20 | +has(key: string): boolean; |
| 21 | +``` |
| 22 | + |
| 23 | +### get |
| 24 | + |
| 25 | +获取指定 key 的值 |
| 26 | + |
| 27 | +```typescript |
| 28 | +/** |
| 29 | + * 获取指定 key 的值 |
| 30 | + * get value by key |
| 31 | + * @param key |
| 32 | + * @param defaultValue |
| 33 | + * @returns |
| 34 | + */ |
| 35 | +get(key: string, defaultValue?: any): any; |
| 36 | +``` |
| 37 | + |
| 38 | +### set |
| 39 | + |
| 40 | +设置指定 key 的值 |
| 41 | + |
| 42 | +```typescript |
| 43 | +/** |
| 44 | + * 设置指定 key 的值 |
| 45 | + * set value for certain key |
| 46 | + * @param key |
| 47 | + * @param value |
| 48 | + */ |
| 49 | +set(key: string, value: any): void; |
| 50 | +``` |
| 51 | + |
| 52 | +### setConfig |
| 53 | +批量设值，set 的对象版本 |
| 54 | + |
| 55 | +```typescript |
| 56 | +/** |
| 57 | + * 批量设值，set 的对象版本 |
| 58 | + * set multiple config key-values |
| 59 | + * @param config |
| 60 | + */ |
| 61 | +setConfig(config: { [key: string]: any }): void; |
| 62 | +``` |
| 63 | + |
| 64 | +### getPreference |
| 65 | +获取全局 Preference, 用于管理全局浏览器侧用户 Preference，如 Panel 是否钉住 |
| 66 | + |
| 67 | +```typescript |
| 68 | +/** |
| 69 | + * 获取全局 Preference, 用于管理全局浏览器侧用户 Preference，如 Panel 是否钉住 |
| 70 | + * get global user preference manager, which can be use to store |
| 71 | + * user`s preference in user localstorage, such as a panel is pinned or not. |
| 72 | + * @returns {IPublicModelPreference} |
| 73 | + * @since v1.1.0 |
| 74 | + */ |
| 75 | +getPreference(): IPublicModelPreference; |
| 76 | +``` |
| 77 | + |
| 78 | +相关类型：[IPublicModelPreference](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/preference.ts) |
| 79 | + |
| 80 | +## 事件 |
| 81 | + |
| 82 | +### onGot |
| 83 | +获取指定 key 的值，函数回调模式，若多次被赋值，回调会被多次调用 |
| 84 | + |
| 85 | +```typescript |
| 86 | +/** |
| 87 | + * 获取指定 key 的值，函数回调模式，若多次被赋值，回调会被多次调用 |
| 88 | + * set callback for event of value set for some key |
| 89 | + * this will be called each time the value is set |
| 90 | + * @param key |
| 91 | + * @param fn |
| 92 | + * @returns |
| 93 | + */ |
| 94 | +onGot(key: string, fn: (data: any) => void): IPublicTypeDisposable; |
| 95 | +``` |
| 96 | + |
| 97 | +相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts) |
| 98 | + |
| 99 | +### onceGot |
| 100 | +获取指定 key 的值，若此时还未赋值，则等待，若已有值，则直接返回值 |
| 101 | +> 注：此函数返回 Promise 实例，只会执行（fullfill）一次 |
| 102 | +
|
| 103 | +```typescript |
| 104 | +/** |
| 105 | + * 获取指定 key 的值，若此时还未赋值，则等待，若已有值，则直接返回值 |
| 106 | + * 注：此函数返回 Promise 实例，只会执行（fullfill）一次 |
| 107 | + * wait until value of certain key is set, will only be |
| 108 | + * triggered once. |
| 109 | + * @param key |
| 110 | + * @returns |
| 111 | + */ |
| 112 | +onceGot(key: string): Promise<any>; |
| 113 | +``` |
0 commit comments