API Reference
@univerjs
@univerjs/core
classes
Configservice

@univerjs/core v0.4.2Docs


Class: ConfigService

Implements

Constructors

new ConfigService()

new ConfigService(): ConfigService

Returns

ConfigService

Properties

PropertyModifierTypeDefined in
configChanged$readonlyObservable<{}>submodules/univer/packages/core/src/services/config/config.service.ts:56 (opens in a new tab)

Methods

deleteConfig()

deleteConfig(id): boolean

Parameters

ParameterType
idstring | symbol

Returns

boolean

Implementation of

IConfigService.deleteConfig

Defined in

submodules/univer/packages/core/src/services/config/config.service.ts:83 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Defined in

submodules/univer/packages/core/src/services/config/config.service.ts:60 (opens in a new tab)


getConfig()

getConfig<T>(id): Nullable<T>

Type Parameters

Type Parameter
T

Parameters

ParameterType
idstring | symbol

Returns

Nullable<T>

Implementation of

IConfigService.getConfig

Defined in

submodules/univer/packages/core/src/services/config/config.service.ts:64 (opens in a new tab)


setConfig()

setConfig(
   id, 
   value, 
   options?): void

Parameters

ParameterType
idstring
valueunknown
options?IConfigOptions

Returns

void

Implementation of

IConfigService.setConfig

Defined in

submodules/univer/packages/core/src/services/config/config.service.ts:68 (opens in a new tab)


subscribeConfigValue$()

subscribeConfigValue$<T>(key): Observable<T>

Type Parameters

Type ParameterDefault type
Tunknown

Parameters

ParameterType
keystring

Returns

Observable<T>

Implementation of

IConfigService.subscribeConfigValue$

Defined in

submodules/univer/packages/core/src/services/config/config.service.ts:87 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.