API Reference
@univerjs
@univerjs/engine-formula
classes
Asyncobject

@univerjs/engine-formula v0.1.17Docs


Class: AsyncObject

Extends

  • ObjectClassType

Constructors

new AsyncObject()

new AsyncObject(_promise): AsyncObject

Parameters

ParameterType
_promisePromise<BaseValueObject>

Returns

AsyncObject

Overrides

ObjectClassType.constructor

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:596 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseObjectClassType._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
patternpublicstring''ObjectClassType.patternpackages/engine-formula/src/basics/object-class-type.ts:20 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

ObjectClassType.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

ObjectClassType.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

ObjectClassType.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


getPattern()

getPattern(): string

Returns

string

Inherited from

ObjectClassType.getPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:22 (opens in a new tab)


getValue()

getValue(): Promise<BaseValueObject>

Returns

Promise<BaseValueObject>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:604 (opens in a new tab)


isArray()

isArray(): boolean

Returns

boolean

Inherited from

ObjectClassType.isArray

Defined in

packages/engine-formula/src/basics/object-class-type.ts:50 (opens in a new tab)


isAsyncArrayObject()

isAsyncArrayObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isAsyncArrayObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:42 (opens in a new tab)


isAsyncObject()

isAsyncObject(): boolean

Returns

boolean

Overrides

ObjectClassType.isAsyncObject

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:600 (opens in a new tab)


isEqualType()

isEqualType(object): boolean

Parameters

ParameterType
objectObjectClassType

Returns

boolean

Inherited from

ObjectClassType.isEqualType

Defined in

packages/engine-formula/src/basics/object-class-type.ts:58 (opens in a new tab)


isError()

isError(): boolean

Returns

boolean

Inherited from

ObjectClassType.isError

Defined in

packages/engine-formula/src/basics/object-class-type.ts:34 (opens in a new tab)


isReferenceObject()

isReferenceObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isReferenceObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:46 (opens in a new tab)


isValueObject()

isValueObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isValueObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:54 (opens in a new tab)


setPattern()

setPattern(pattern): void

Only used in NumberValueObject

Parameters

ParameterType
patternstring

Returns

void

Inherited from

ObjectClassType.setPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:30 (opens in a new tab)


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