Skip to content

SOF-7161: clean in_memory prop() method #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 29, 2024
Merged

SOF-7161: clean in_memory prop() method #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion dist/entity/in_memory.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ export declare class InMemoryEntity {
static readonly jsonSchema?: JSONSchema;
_json: AnyObject;
constructor(config?: {});
prop<T = null>(name: string, defaultValue?: T): T;
prop<T = undefined>(name: string, defaultValue: T): T;
prop<T = undefined>(name: string): T | undefined;
/**
* @summary Set a prop
*/
Expand Down
3 changes: 1 addition & 2 deletions dist/entity/in_memory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ class InMemoryEntity {
}
/**
* @summary Return a prop or the default
* @returns {*}
*/
prop(name, defaultValue = null) {
prop(name, defaultValue) {
// `lodash.get` gets `null` when the value is `null`, but we still want a default value in this case, hence `||`
return (0, get_1.default)(this._json, name, defaultValue) || defaultValue;
}
Expand Down
13 changes: 8 additions & 5 deletions dist/entity/mixins/context.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ export declare function ContextAndRenderFieldsMixin<T extends InMemoryEntityCons
_context: Context;
context: AnyObject;
updateContext(ctx?: {}, executeRender?: boolean): void;
getPersistentContext(): object;
getPersistentContext(): object | undefined;
updatePersistentContext(ctx?: object): void;
getCombinedContext(): {
[x: string]: unknown;
};
render(context?: AnyObject): void;
_json: AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand All @@ -39,7 +40,8 @@ export declare function DomainContextProviderMixin<T extends InMemoryEntityConst
_contextProviders: ContextProvider[];
readonly contextProviders: ContextProvider[];
_json: AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand All @@ -63,11 +65,12 @@ export declare function ImportantSettingsProviderMixin<T extends InMemoryEntityC
readonly important: any;
setImportant(key: string, value: unknown): void;
readonly importantSettingsProviders: ContextProvider[];
isImportantEdited: boolean;
isImportantEdited: boolean | undefined;
_contextProviders: ContextProvider[];
readonly contextProviders: ContextProvider[];
_json: AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand Down
3 changes: 2 additions & 1 deletion dist/entity/mixins/context_runtime.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ export declare function RuntimeContextFieldMixin<T extends InMemoryEntityConstru
runtimeContext: {};
};
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSONSafe(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down
8 changes: 5 additions & 3 deletions dist/entity/mixins/flowchart.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ export declare function FlowchartItemMixin<T extends InMemoryEntityConstructor>(
new (...params: any[]): {
readonly flowchartId: string;
head: boolean;
next: string;
next: string | undefined;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down Expand Up @@ -36,7 +37,8 @@ export declare function FlowchartEntityMixin<T extends InMemoryEntityConstructor
getUnit(flowchartId: string): UnitEntity | undefined;
getUnitIndexByFlowchartId(flowchartId: string): number;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down
6 changes: 4 additions & 2 deletions dist/entity/mixins/hash.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ export declare function HashedEntityMixin<T extends InMemoryEntityConstructor>(s
*/
calculateHash(): string;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -34,7 +35,8 @@ export declare function HashedInputArrayMixin<T extends InMemoryEntityConstructo
input: ExecutionUnitInputItemSchemaForPhysicsBasedSimulationEngines[];
readonly hashFromArrayInputContent: string;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down
23 changes: 15 additions & 8 deletions dist/entity/mixins/props.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ export declare function DefaultableMixin<T extends InMemoryEntityConstructor>(su
new (...args: any[]): {
readonly isDefault: boolean;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -29,7 +30,8 @@ export declare function TaggableMixin<T extends InMemoryEntityConstructor>(super
tags: string[];
setTags(array: string[]): void;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -52,7 +54,8 @@ export declare function HasScopeTrackMixin<T extends InMemoryEntityConstructor>(
new (...args: any[]): {
scopeTrack: unknown[];
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -76,7 +79,8 @@ export declare function HasMetadataMixin<T extends InMemoryEntityConstructor>(su
metadata: object;
updateMetadata(object: object): void;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -98,9 +102,10 @@ export declare function HasMetadataMixin<T extends InMemoryEntityConstructor>(su
export declare function HasDescriptionMixin<T extends InMemoryEntityConstructor>(superclass: T): {
new (...args: any[]): {
description: string;
descriptionObject: {};
descriptionObject: {} | undefined;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -124,7 +129,8 @@ export declare function NamedEntityMixin<T extends InMemoryEntityConstructor>(su
name: string;
setName(name: string): void;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand All @@ -148,7 +154,8 @@ export declare function HasConsistencyChecksMixin<T extends InMemoryEntityConstr
consistencyChecks: object[];
addConsistencyChecks(array: object[]): void;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down
3 changes: 2 additions & 1 deletion dist/entity/mixins/repetition.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ export declare function HasRepetitionMixin<T extends InMemoryEntityConstructor>(
readonly totalRepetitions: number;
setTotalRepetitions(totalRepetition: number): void;
_json: import("../in_memory").AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
Expand Down
9 changes: 6 additions & 3 deletions dist/entity/mixins/runtime_items.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export declare function RuntimeItemsMixin<T extends InMemoryEntityConstructor>(s
postProcessors: NameResultSchema[];
};
_json: AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand Down Expand Up @@ -85,7 +86,8 @@ export declare function RuntimeItemsUILogicMixin<T extends InMemoryEntityConstru
preProcessors: NameResultSchema[];
postProcessors: NameResultSchema[];
};
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand All @@ -110,7 +112,8 @@ export declare function RuntimeItemsUIAllowedMixin<T extends InMemoryEntityConst
readonly allowedMonitors: never[];
readonly allowedPostProcessors: never[];
_json: AnyObject;
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
prop<T_2 = undefined>(name: string): T_2 | undefined;
setProp(name: string, value: unknown): void;
unsetProp(name: string): void;
toJSON(exclude?: string[]): AnyObject;
Expand Down
Loading