chrisklus
commented
1 year ago Patch that @zepumph and I have been experimenting with:
```diff
Index: phet-core/js/optionize.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/phet-core/js/optionize.ts b/phet-core/js/optionize.ts
--- a/phet-core/js/optionize.ts (revision 59ec4e8b026d1ddb9e8d3d9a030ca19010243182)
+++ b/phet-core/js/optionize.ts (date 1671045305538)
@@ -36,16 +36,19 @@
type EmptySelfOptionsKeys = keyof EmptySelfOptions;
// This is the type for the `defaults` argument to optionize
-export type HalfOptions =
+export type HalfOptions =
// Everything optional from SelfOptions must have a default specified
Omit>, EmptySelfOptionsKeys> & // eslint-disable-line @typescript-eslint/ban-types
+ // TODO: Anything required in ParentOptions should be required if it wasn't provided through ParentOptions
+ // TODO: Convey that these keys are not undefined because they were provided in defaults
// Any or none of Parent options can be provided
- Partial;
+ Pick;
// This is the type for the `defaults` argument to optionize
-type OptionizeDefaults =
+type OptionizeDefaults =
// Everything optional from SelfOptions must have a default specified
Omit>, EmptySelfOptionsKeys> & // eslint-disable-line @typescript-eslint/ban-types
@@ -53,9 +56,9 @@
// Any or none of Parent options can be provided
Partial &
- // Any keys provided in KeysUsedInSubclassConstructor are required to have a default provided, with the assumption
+ // Any keys provided in ParentOptionKeysInDefaults are required to have a default provided, with the assumption
// that they will be used from the return type of optionize.
- Required>;
+ Required>;
// Factor out the merge arrow closure to avoid heap/cpu at runtime
const merge4 = ( a: IntentionalAny, b?: IntentionalAny, c?: IntentionalAny, d?: IntentionalAny ) => merge( a, b, c, d );
@@ -63,14 +66,14 @@
// ProvidedOptions = The type of this class's public API (type of the providedOptions parameter in the constructor)
// SelfOptions = Options that are defined by "this" class. Anything optional in this block must have a default provided in "defaults"
// ParentOptions = The public API for parent options, this will be exported by the parent class, like "NodeOptions"
-// KeysUsedInSubclassConstructor = list of keys from ParentOptions that are used in this constructor.
+// ParentOptionKeysInDefaults = list of keys from ParentOptions that were provided in the defaults.
export default function optionize>():
- (
- defaults: HalfOptions,
+ (
+ defaults: HalfOptions,
providedOptions?: ProvidedOptions
- ) => HalfOptions & ProvidedOptions & Required> {
+ ) => HalfOptions & ProvidedOptions {
return merge4;
}
@@ -78,11 +81,11 @@
export function optionize3>():
- (
+ (
emptyObject: ObjectWithNoKeys,
defaults: HalfOptions,
providedOptions?: ProvidedOptions
- ) => HalfOptions & ProvidedOptions & Required> {
+ ) => HalfOptions & ProvidedOptions & Required> {
return merge4;
}
@@ -104,12 +107,12 @@
export function optionize4():
- (
+ (
emptyObject: ObjectWithNoKeys,
defaults1: Partial,
defaults2: HalfOptions,
providedOptions?: ProvidedOptions
- ) => HalfOptions & ProvidedOptions & Required> {
+ ) => HalfOptions & ProvidedOptions & Required> {
return merge4;
}
@@ -122,21 +125,21 @@
// function optionize():
-// (
+// (
// emptyObject: ObjectWithNoKeys,
// defaults: HalfOptions,
// providedOptions?: ProvidedOptions
-// ) => HalfOptions & ProvidedOptions & Required>;
+// ) => HalfOptions & ProvidedOptions & Required>;
//
// function optionize():
+// ParentOptionKeysInDefaults extends keyof ParentOptions = never>():
// (
// empytObject: ObjectWithNoKeys,
-// defaults: OptionizeDefaults,
+// defaults: OptionizeDefaults,
// providedOptions?: ProvidedOptions
-// ) => ObjectWithNoKeys & OptionizeDefaults & ProvidedOptions;
+// ) => ObjectWithNoKeys & OptionizeDefaults & ProvidedOptions;
// The implementation gets "any" types because of the above signatures
// function optionize() { return ( a: any, b?: any, c?: any ) => merge( a, b, c ); } // eslint-disable-line no-redeclare,bad-text
Index: wilder/js/wilder/model/WilderOptionsPatterns.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/wilder/js/wilder/model/WilderOptionsPatterns.ts b/wilder/js/wilder/model/WilderOptionsPatterns.ts
--- a/wilder/js/wilder/model/WilderOptionsPatterns.ts (revision abea7107ba9e9d65298e7cd2f593a036f5e58dab)
+++ b/wilder/js/wilder/model/WilderOptionsPatterns.ts (date 1671046682693)
@@ -271,6 +271,11 @@
options.children.push( new MyItem() );
super( options );
+ this.hello( options.children );
+ }
+
+ hello( items: Item[] ) {
+
}
}
@@ -640,6 +645,40 @@
items.push( new AnotherItem( { x: 5 } ) );
+/////////
+// Example Fifteen
+//
+//
+
+type GalaxyClassOptions = {
+ warpSpeed: number;
+};
+
+class GalaxyClass {
+ topSpeed: number;
+
+ constructor( options: GalaxyClassOptions ) {
+ this.topSpeed = options.warpSpeed;
+ }
+}
+
+type EnterpriseOptions = EmptySelfOptions & StrictOmit;
+// type EnterpriseOptions = EmptySelfOptions & GalaxyClassOptions;
+
+class Enterprise extends GalaxyClass {
+
+ constructor( providedOptions: EnterpriseOptions ) {
+
+ const options = optionize()( {
+ // warpSpeed: 10
+ }, providedOptions );
+
+ super( options );
+ }
+}
+
+const enterpriseD = new Enterprise( {} );
+
////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////
@@ -737,6 +776,7 @@
console.log( providedOptions.isRequiredAwesome );
const options = optionize()( {
+ name: 'hi',
// blarg: true,
isAwesome: true, // (2)
// hasShirt: false, // (3)
Index: center-and-variability/js/median/view/MedianScreenView.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/center-and-variability/js/median/view/MedianScreenView.ts b/center-and-variability/js/median/view/MedianScreenView.ts
--- a/center-and-variability/js/median/view/MedianScreenView.ts (revision e554302408018883973ace6db3d867dd584f651e)
+++ b/center-and-variability/js/median/view/MedianScreenView.ts (date 1671046682698)
@@ -27,7 +27,7 @@
const options = optionize()( {
// TODO-TS: Why are isMedianScreen and questionBarOptions optional here? see https://github.com/phetsims/phet-core/issues/130
- isMedianScreen: true,
+ // isMedianScreen: true,
questionBarOptions: {
barFill: CAVColors.medianQuestionBarFillColorProperty,
questionString: CenterAndVariabilityStrings.medianQuestion
@@ -48,6 +48,10 @@
tandem: Tandem.REQUIRED
}, providedOptions );
+ const hello = options.isMedianScreen;
+
+ type x = MeanOrMedianScreenViewOptions[ 'isMedianScreen' ];
+
super( model, options );
}
}
```
zepumph
amanda-phet
samreid
pixelzoom
@samreid and I were working on omitting ts-expect-error in https://github.com/phetsims/chipper/issues/1366 and found a case where omitting a required super option from the call site option type and then still not including that required option in optionize defaults did not error.
@zepumph was able to take a look with us before having to go and suggested taking a look at example nine in wilder options patterns. We tried using
WithOptionallike in that case but had no luck. @zepumph could you please take a look again sometime, async or pairing with one of us? Thanks!Please look for this issue link in code.