---
title: config - é…ç½® API
sidebar_position: 5
---
> **@types** [IPublicModelEngineConfig](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/engine-config.ts)
> **@since** v1.0.0
## 模å—简介
é…置模å—，负责é…置的读ã€å†™ç‰æ“作。
## 方法
### get
获å–指定 key 的值
```typescript
/**
* 获å–指定 key 的值
* get value by key
* @param key
* @param defaultValue
* @returns
*/
get(key: string, defaultValue?: any): any;
```
**示例**
```typescript
import { config } from '@alilc/lowcode-engine';
config.get('keyA', true);
config.get('keyB', { a: 1 });
```
### set
设置指定 key 的值
```typescript
/**
* 设置指定 key 的值
* set value for certain key
* @param key
* @param value
*/
set(key: string, value: any): void;
```
**示例**
```typescript
import { config } from '@alilc/lowcode-engine';
config.set('keyC', 1);
```
### has
判æ–指定 key 是å¦æœ‰å€¼
```typescript
/**
* 判æ–指定 key 是å¦æœ‰å€¼
* check if config has certain key configed
* @param key
* @returns
*/
has(key: string): boolean;
```
**示例**
```typescript
import { config } from '@alilc/lowcode-engine';
config.has('keyD');
```
### setConfig
批é‡è®¾å€¼ï¼Œset 的对象版本
```typescript
/**
* 批é‡è®¾å€¼ï¼Œset 的对象版本
* set multiple config key-values
* @param config
*/
setConfig(config: { [key: string]: any }): void;
```
**示例**
```typescript
import { config } from '@alilc/lowcode-engine';
config.setConfig({ keyA: false, keyB: 2 });
```
### getPreference
获å–全局 Preference 管ç†å™¨ï¼Œç”¨äºŽç®¡ç†å…¨å±€æµè§ˆå™¨ä¾§ç”¨æˆ· Preference，如 Panel 是å¦é’‰ä½
```typescript
/**
* 获å–全局 Preference, 用于管ç†å…¨å±€æµè§ˆå™¨ä¾§ç”¨æˆ· Preference，如 Panel 是å¦é’‰ä½
* get global user preference manager, which can be use to store
* user`s preference in user localstorage, such as a panel is pinned or not.
* @returns {IPublicModelPreference}
* @since v1.1.0
*/
getPreference(): IPublicModelPreference;
```
相关类型：[IPublicModelPreference](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/preference.ts)
**@since v1.1.0**
示例
```javascript
import { config } from '@alilc/lowcode-engine';
const panelName = 'outline-master-pane';
// è®¾ç½®å¤§çº²æ ‘é¢æ¿é’‰ä½ï¼Œåœ¨å¤§çº²æ ‘下次é‡æ–°æ‰“开时生效
config.getPreference().set(`${panelName}-pinned-status-isFloat`, false, 'skeleton')
```
## 事件
### onceGot
获å–指定 key 的值，若æ¤æ—¶è¿˜æœªèµ‹å€¼ï¼Œåˆ™ç‰å¾…，若已有值，则直接返回值
注：æ¤å‡½æ•°è¿”回 Promise 实例
```typescript
/**
* 获å–指定 key 的值，若æ¤æ—¶è¿˜æœªèµ‹å€¼ï¼Œåˆ™ç‰å¾…，若已有值，则直接返回值
* 注：æ¤å‡½æ•°è¿”回 Promise 实例，åªä¼šæ‰§è¡Œï¼ˆfullfill）一次
* wait until value of certain key is set, will only be
* triggered once.
* @param key
* @returns
*/
onceGot(key: string): Promise