Skip to content

Commit 7670852

Browse files
committed
rename some interfaces
1 parent 02b0854 commit 7670852

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

lib/preview-frame-interface.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
// to be explicit about importing these interfaces so that the source
77
// code is easier to understand.
88

9-
export interface PreviewFrameErrorReporter {
9+
export interface ErrorReporter {
1010
(message: string, line?: number): any
1111
}
1212

1313
// Eventually we might want the preview frame to exist on a separate
1414
// origin for security, which means that we'd have to use postMessage()
1515
// to communicate with it. Thus this interface needs to be asynchronous.
16-
export interface PreviewFrame extends Window {
16+
export interface Runner extends Window {
1717
startSketch: (sketch: string, p5version: string, maxRunTime: number,
1818
loopCheckFuncName: string, baseURL: string,
19-
errorCb: PreviewFrameErrorReporter) => void
19+
errorCb: ErrorReporter) => void
2020
}

lib/preview-frame.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
import { PreviewFrame,
2-
PreviewFrameErrorReporter } from "./preview-frame-interface";
1+
import * as PreviewFrame from "./preview-frame-interface";
32

43
require("../css/preview-frame.css");
54

6-
interface PreviewFrameWindow extends PreviewFrame {
5+
interface PreviewFrameWindow extends PreviewFrame.Runner {
76
// This is exported by p5 when it's in global mode.
87
noLoop: () => void;
98
}
@@ -64,7 +63,7 @@ function setBaseURL(url: string) {
6463

6564
function startSketch(sketch: string, p5version: string, maxRunTime: number,
6665
loopCheckFuncName: string, baseURL: string,
67-
errorCb: PreviewFrameErrorReporter) {
66+
errorCb: PreviewFrame.ErrorReporter) {
6867
let sketchScript = document.createElement('script');
6968
let loopChecker = LoopChecker(sketch, loopCheckFuncName, maxRunTime);
7069

lib/preview.tsx

+3-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ import falafel from "./falafel";
44
import LoopInserter from "./loop-inserter";
55
import makeImplicitSketch from "./implicit-sketch";
66
import PureComponent from "./pure-component";
7-
import { PreviewFrame,
8-
PreviewFrameErrorReporter } from "./preview-frame-interface";
7+
import * as PreviewFrame from "./preview-frame-interface";
98

109
const LOOP_CHECK_FUNC_NAME = '__loopCheck';
1110

@@ -15,7 +14,7 @@ interface Props {
1514
content: string,
1615
baseSketchURL: string,
1716
timestamp: number,
18-
onError: PreviewFrameErrorReporter
17+
onError: PreviewFrame.ErrorReporter
1918
}
2019

2120
interface State {
@@ -53,7 +52,7 @@ export default class Preview extends PureComponent<Props, State> {
5352
// Note that this should never be called if we're already unmounted,
5453
// since that means the iframe will have been removed from the DOM,
5554
// in which case it shouldn't be emitting events anymore.
56-
let frame = iframe.contentWindow as PreviewFrame;
55+
let frame = iframe.contentWindow as PreviewFrame.Runner;
5756
frame.startSketch(content, this.props.p5version, 1000,
5857
LOOP_CHECK_FUNC_NAME,
5958
this.props.baseSketchURL,

0 commit comments

Comments
 (0)