Skip to content

Commit 27c8edd

Browse files
committed
Add typings for returned object properties
1 parent f5b6903 commit 27c8edd

File tree

3 files changed

+21
-10
lines changed

3 files changed

+21
-10
lines changed

docs/parameterData.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3505,9 +3505,8 @@
35053505
},
35063506
"time": {
35073507
"overloads": [
3508-
[],
35093508
[
3510-
"Number"
3509+
"Number?"
35113510
]
35123511
]
35133512
},

src/dom/p5.MediaElement.js

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,7 @@ class MediaElement extends Element {
628628
*
629629
* Note: Time resets to 0 when looping media restarts.
630630
*
631+
* @param {Number} [time] time to jump to (in seconds).
631632
* @return {Number} current time (in seconds).
632633
*
633634
* @example
@@ -704,17 +705,11 @@ class MediaElement extends Element {
704705
* </code>
705706
* </div>
706707
*/
707-
/**
708-
* @param {Number} time time to jump to (in seconds).
709-
* @chainable
710-
*/
711708
time(val) {
712-
if (typeof val === 'undefined') {
713-
return this.elt.currentTime;
714-
} else {
709+
if (typeof val !== 'undefined') {
715710
this.elt.currentTime = val;
716-
return this;
717711
}
712+
return this.elt.currentTime;
718713
}
719714

720715
/**

utils/patch.mjs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,23 @@ export function applyPatches() {
9393
'createVideo(src?: string | string[], callback?: (video: $1.MediaElement<HTMLVideoElement>) => any): $1.MediaElement<HTMLVideoElement>;',
9494
);
9595

96+
// Type returned objects
97+
replace(
98+
'p5.d.ts',
99+
'calculateBoundingBox(): object;',
100+
'calculateBoundingBox(): { min: p5.Vector; max: p5.Vector; size: p5.Vector; offset: p5.Vector };'
101+
);
102+
replace(
103+
'p5.d.ts',
104+
'fontBounds(str: string, x: number, y: number, width?: number, height?: number): object;',
105+
'fontBounds(str: string, x: number, y: number, width?: number, height?: number): { x: number; y: number; w: number; h: number };',
106+
);
107+
replace(
108+
'p5.d.ts',
109+
'textBounds(str: string, x: number, y: number, width?: number, height?: number): object;',
110+
'textBounds(str: string, x: number, y: number, width?: number, height?: number): { x: number; y: number; w: number; h: number };',
111+
);
112+
96113
for (const [path, data] of Object.entries(patched)) {
97114
try {
98115
console.log(`Patched ${path}`);

0 commit comments

Comments
 (0)