Skip to content

Commit 766605b

Browse files
authored
Merge pull request #94 from Exabyte-io/update/SOF-7161
SOF-7161: clean in_memory prop() method
2 parents 9d6a42e + 76f335c commit 766605b

24 files changed

+969
-759
lines changed

dist/entity/in_memory.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ export declare class InMemoryEntity {
2626
static readonly jsonSchema?: JSONSchema;
2727
_json: AnyObject;
2828
constructor(config?: {});
29-
prop<T = null>(name: string, defaultValue?: T): T;
29+
prop<T = undefined>(name: string, defaultValue: T): T;
30+
prop<T = undefined>(name: string): T | undefined;
3031
/**
3132
* @summary Set a prop
3233
*/

dist/entity/in_memory.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,8 @@ class InMemoryEntity {
5555
}
5656
/**
5757
* @summary Return a prop or the default
58-
* @returns {*}
5958
*/
60-
prop(name, defaultValue = null) {
59+
prop(name, defaultValue) {
6160
// `lodash.get` gets `null` when the value is `null`, but we still want a default value in this case, hence `||`
6261
return (0, get_1.default)(this._json, name, defaultValue) || defaultValue;
6362
}

dist/entity/mixins/context.d.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ export declare function ContextAndRenderFieldsMixin<T extends InMemoryEntityCons
55
_context: Context;
66
context: AnyObject;
77
updateContext(ctx?: {}, executeRender?: boolean): void;
8-
getPersistentContext(): object;
8+
getPersistentContext(): object | undefined;
99
updatePersistentContext(ctx?: object): void;
1010
getCombinedContext(): {
1111
[x: string]: unknown;
1212
};
1313
render(context?: AnyObject): void;
1414
_json: AnyObject;
15-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
15+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
16+
prop<T_2 = undefined>(name: string): T_2 | undefined;
1617
setProp(name: string, value: unknown): void;
1718
unsetProp(name: string): void;
1819
toJSON(exclude?: string[]): AnyObject;
@@ -39,7 +40,8 @@ export declare function DomainContextProviderMixin<T extends InMemoryEntityConst
3940
_contextProviders: ContextProvider[];
4041
readonly contextProviders: ContextProvider[];
4142
_json: AnyObject;
42-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
43+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
44+
prop<T_2 = undefined>(name: string): T_2 | undefined;
4345
setProp(name: string, value: unknown): void;
4446
unsetProp(name: string): void;
4547
toJSON(exclude?: string[]): AnyObject;
@@ -63,11 +65,12 @@ export declare function ImportantSettingsProviderMixin<T extends InMemoryEntityC
6365
readonly important: any;
6466
setImportant(key: string, value: unknown): void;
6567
readonly importantSettingsProviders: ContextProvider[];
66-
isImportantEdited: boolean;
68+
isImportantEdited: boolean | undefined;
6769
_contextProviders: ContextProvider[];
6870
readonly contextProviders: ContextProvider[];
6971
_json: AnyObject;
70-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
72+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
73+
prop<T_2 = undefined>(name: string): T_2 | undefined;
7174
setProp(name: string, value: unknown): void;
7275
unsetProp(name: string): void;
7376
toJSON(exclude?: string[]): AnyObject;

dist/entity/mixins/context_runtime.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ export declare function RuntimeContextFieldMixin<T extends InMemoryEntityConstru
1010
runtimeContext: {};
1111
};
1212
_json: import("../in_memory").AnyObject;
13-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
13+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
14+
prop<T_2 = undefined>(name: string): T_2 | undefined;
1415
setProp(name: string, value: unknown): void;
1516
unsetProp(name: string): void;
1617
toJSONSafe(exclude?: string[]): import("../in_memory").AnyObject;

dist/entity/mixins/flowchart.d.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ export declare function FlowchartItemMixin<T extends InMemoryEntityConstructor>(
44
new (...params: any[]): {
55
readonly flowchartId: string;
66
head: boolean;
7-
next: string;
7+
next: string | undefined;
88
_json: import("../in_memory").AnyObject;
9-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
9+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
10+
prop<T_2 = undefined>(name: string): T_2 | undefined;
1011
setProp(name: string, value: unknown): void;
1112
unsetProp(name: string): void;
1213
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -36,7 +37,8 @@ export declare function FlowchartEntityMixin<T extends InMemoryEntityConstructor
3637
getUnit(flowchartId: string): UnitEntity | undefined;
3738
getUnitIndexByFlowchartId(flowchartId: string): number;
3839
_json: import("../in_memory").AnyObject;
39-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
40+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
41+
prop<T_2 = undefined>(name: string): T_2 | undefined;
4042
setProp(name: string, value: unknown): void;
4143
unsetProp(name: string): void;
4244
toJSON(exclude?: string[]): import("../in_memory").AnyObject;

dist/entity/mixins/hash.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ export declare function HashedEntityMixin<T extends InMemoryEntityConstructor>(s
1010
*/
1111
calculateHash(): string;
1212
_json: import("../in_memory").AnyObject;
13-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
13+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
14+
prop<T_2 = undefined>(name: string): T_2 | undefined;
1415
setProp(name: string, value: unknown): void;
1516
unsetProp(name: string): void;
1617
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -34,7 +35,8 @@ export declare function HashedInputArrayMixin<T extends InMemoryEntityConstructo
3435
input: ExecutionUnitInputItemSchemaForPhysicsBasedSimulationEngines[];
3536
readonly hashFromArrayInputContent: string;
3637
_json: import("../in_memory").AnyObject;
37-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
38+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
39+
prop<T_2 = undefined>(name: string): T_2 | undefined;
3840
setProp(name: string, value: unknown): void;
3941
unsetProp(name: string): void;
4042
toJSON(exclude?: string[]): import("../in_memory").AnyObject;

dist/entity/mixins/props.d.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ export declare function DefaultableMixin<T extends InMemoryEntityConstructor>(su
33
new (...args: any[]): {
44
readonly isDefault: boolean;
55
_json: import("../in_memory").AnyObject;
6-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
6+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
7+
prop<T_2 = undefined>(name: string): T_2 | undefined;
78
setProp(name: string, value: unknown): void;
89
unsetProp(name: string): void;
910
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -29,7 +30,8 @@ export declare function TaggableMixin<T extends InMemoryEntityConstructor>(super
2930
tags: string[];
3031
setTags(array: string[]): void;
3132
_json: import("../in_memory").AnyObject;
32-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
33+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
34+
prop<T_2 = undefined>(name: string): T_2 | undefined;
3335
setProp(name: string, value: unknown): void;
3436
unsetProp(name: string): void;
3537
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -52,7 +54,8 @@ export declare function HasScopeTrackMixin<T extends InMemoryEntityConstructor>(
5254
new (...args: any[]): {
5355
scopeTrack: unknown[];
5456
_json: import("../in_memory").AnyObject;
55-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
57+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
58+
prop<T_2 = undefined>(name: string): T_2 | undefined;
5659
setProp(name: string, value: unknown): void;
5760
unsetProp(name: string): void;
5861
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -76,7 +79,8 @@ export declare function HasMetadataMixin<T extends InMemoryEntityConstructor>(su
7679
metadata: object;
7780
updateMetadata(object: object): void;
7881
_json: import("../in_memory").AnyObject;
79-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
82+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
83+
prop<T_2 = undefined>(name: string): T_2 | undefined;
8084
setProp(name: string, value: unknown): void;
8185
unsetProp(name: string): void;
8286
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -98,9 +102,10 @@ export declare function HasMetadataMixin<T extends InMemoryEntityConstructor>(su
98102
export declare function HasDescriptionMixin<T extends InMemoryEntityConstructor>(superclass: T): {
99103
new (...args: any[]): {
100104
description: string;
101-
descriptionObject: {};
105+
descriptionObject: {} | undefined;
102106
_json: import("../in_memory").AnyObject;
103-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
107+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
108+
prop<T_2 = undefined>(name: string): T_2 | undefined;
104109
setProp(name: string, value: unknown): void;
105110
unsetProp(name: string): void;
106111
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -124,7 +129,8 @@ export declare function NamedEntityMixin<T extends InMemoryEntityConstructor>(su
124129
name: string;
125130
setName(name: string): void;
126131
_json: import("../in_memory").AnyObject;
127-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
132+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
133+
prop<T_2 = undefined>(name: string): T_2 | undefined;
128134
setProp(name: string, value: unknown): void;
129135
unsetProp(name: string): void;
130136
toJSON(exclude?: string[]): import("../in_memory").AnyObject;
@@ -148,7 +154,8 @@ export declare function HasConsistencyChecksMixin<T extends InMemoryEntityConstr
148154
consistencyChecks: object[];
149155
addConsistencyChecks(array: object[]): void;
150156
_json: import("../in_memory").AnyObject;
151-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
157+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
158+
prop<T_2 = undefined>(name: string): T_2 | undefined;
152159
setProp(name: string, value: unknown): void;
153160
unsetProp(name: string): void;
154161
toJSON(exclude?: string[]): import("../in_memory").AnyObject;

dist/entity/mixins/repetition.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ export declare function HasRepetitionMixin<T extends InMemoryEntityConstructor>(
1717
readonly totalRepetitions: number;
1818
setTotalRepetitions(totalRepetition: number): void;
1919
_json: import("../in_memory").AnyObject;
20-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
20+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
21+
prop<T_2 = undefined>(name: string): T_2 | undefined;
2122
setProp(name: string, value: unknown): void;
2223
unsetProp(name: string): void;
2324
toJSON(exclude?: string[]): import("../in_memory").AnyObject;

dist/entity/mixins/runtime_items.d.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ export declare function RuntimeItemsMixin<T extends InMemoryEntityConstructor>(s
2222
postProcessors: NameResultSchema[];
2323
};
2424
_json: AnyObject;
25-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
25+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
26+
prop<T_2 = undefined>(name: string): T_2 | undefined;
2627
setProp(name: string, value: unknown): void;
2728
unsetProp(name: string): void;
2829
toJSON(exclude?: string[]): AnyObject;
@@ -85,7 +86,8 @@ export declare function RuntimeItemsUILogicMixin<T extends InMemoryEntityConstru
8586
preProcessors: NameResultSchema[];
8687
postProcessors: NameResultSchema[];
8788
};
88-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
89+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
90+
prop<T_2 = undefined>(name: string): T_2 | undefined;
8991
setProp(name: string, value: unknown): void;
9092
unsetProp(name: string): void;
9193
toJSON(exclude?: string[]): AnyObject;
@@ -110,7 +112,8 @@ export declare function RuntimeItemsUIAllowedMixin<T extends InMemoryEntityConst
110112
readonly allowedMonitors: never[];
111113
readonly allowedPostProcessors: never[];
112114
_json: AnyObject;
113-
prop<T_1 = null>(name: string, defaultValue?: T_1 | undefined): T_1;
115+
prop<T_1 = undefined>(name: string, defaultValue: T_1): T_1;
116+
prop<T_2 = undefined>(name: string): T_2 | undefined;
114117
setProp(name: string, value: unknown): void;
115118
unsetProp(name: string): void;
116119
toJSON(exclude?: string[]): AnyObject;

0 commit comments

Comments
 (0)