@finos/legend-shared
Version:
Legend Studio shared utilities and helpers
52 lines • 1.73 kB
TypeScript
/**
* Copyright (c) 2020-present, Goldman Sachs
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
declare enum ACTION_STATE {
INITIAL = "INITIAL",
IN_PROGRESS = "IN_PROGRESS",
SUCCEEDED = "SUCEEDED",
FAILED = "FAILED"
}
export declare class ActionState {
private state;
private _message;
private _messageFormatter;
protected constructor();
setMessage(val: string | undefined): void;
setMessageFormatter(val: ((message: string) => string) | undefined): void;
reset(): ActionState;
inProgress(): ActionState;
fail(): ActionState;
pass(): ActionState;
complete(hasSucceeded?: boolean): ActionState;
sync(val: ActionState): void;
exportData(): {
state: ACTION_STATE;
message: string | undefined;
};
get isInInitialState(): boolean;
get isInProgress(): boolean;
get hasFailed(): boolean;
get hasSucceeded(): boolean;
get message(): string | undefined;
/**
* Use this if only the completion state of the action is of concern,
* i.e. we don't care if it fails or succeeds.
*/
get hasCompleted(): boolean;
static create(): ActionState;
}
export {};
//# sourceMappingURL=ActionState.d.ts.map