From 3ef5e0c92beeaaff6b7848652e5c6d3daf230e2c Mon Sep 17 00:00:00 2001 From: mtgto Date: Fri, 28 Feb 2020 08:44:39 +0900 Subject: [PATCH] [codemirror] Add addon display/autorefresh (#42669) * [codemirror] Add addon display/autorefresh * [codemirror] Fix library name in comment https://github.com/DefinitelyTyped/DefinitelyTyped/pull/42669#discussion_r385291863 --- types/codemirror/addon/comment/comment.d.ts | 2 +- types/codemirror/addon/display/autorefresh.d.ts | 16 ++++++++++++++++ types/codemirror/addon/display/panel.d.ts | 2 +- types/codemirror/addon/edit/closebrackets.d.ts | 2 +- types/codemirror/addon/edit/closetag.d.ts | 2 +- types/codemirror/addon/edit/matchbrackets.d.ts | 2 +- types/codemirror/addon/edit/matchtags.d.ts | 2 +- types/codemirror/addon/hint/show-hint.d.ts | 2 +- types/codemirror/addon/runmode/runmode.d.ts | 2 +- types/codemirror/addon/scroll/scrollpastend.d.ts | 2 +- .../addon/search/match-highlighter.d.ts | 2 +- types/codemirror/addon/search/searchcursor.d.ts | 2 +- .../codemirror/addon/selection/active-line.d.ts | 2 +- types/codemirror/addon/tern/tern.d.ts | 2 +- types/codemirror/index.d.ts | 2 +- .../codemirror/test/addon/display/autorefresh.ts | 6 ++++++ types/codemirror/tsconfig.json | 3 ++- 17 files changed, 38 insertions(+), 15 deletions(-) create mode 100644 types/codemirror/addon/display/autorefresh.d.ts create mode 100644 types/codemirror/test/addon/display/autorefresh.ts diff --git a/types/codemirror/addon/comment/comment.d.ts b/types/codemirror/addon/comment/comment.d.ts index 706e42e807..9905ab4344 100644 --- a/types/codemirror/addon/comment/comment.d.ts +++ b/types/codemirror/addon/comment/comment.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: Nikolaj Kappler // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/display/autorefresh.d.ts b/types/codemirror/addon/display/autorefresh.d.ts new file mode 100644 index 0000000000..e345386ca3 --- /dev/null +++ b/types/codemirror/addon/display/autorefresh.d.ts @@ -0,0 +1,16 @@ +// Type definitions for CodeMirror +// Project: https://github.com/marijnh/CodeMirror +// Definitions by: mtgto +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +// See docs https://codemirror.net/doc/manual.html#addon_autorefresh + +import * as CodeMirror from "codemirror"; + +declare module "codemirror" { + interface EditorConfiguration { + // if true, it will be refreshed the first time the editor becomes visible. + // you can pass delay (msec) time as polling duration + autoRefresh?: boolean | { delay: number }; + } +} diff --git a/types/codemirror/addon/display/panel.d.ts b/types/codemirror/addon/display/panel.d.ts index a361992641..61ac6fd118 100644 --- a/types/codemirror/addon/display/panel.d.ts +++ b/types/codemirror/addon/display/panel.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: Nikolaj Kappler // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/edit/closebrackets.d.ts b/types/codemirror/addon/edit/closebrackets.d.ts index 994789b1c9..a6f534caba 100644 --- a/types/codemirror/addon/edit/closebrackets.d.ts +++ b/types/codemirror/addon/edit/closebrackets.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/edit/closetag.d.ts b/types/codemirror/addon/edit/closetag.d.ts index b9531b4b08..b7cfe1e637 100644 --- a/types/codemirror/addon/edit/closetag.d.ts +++ b/types/codemirror/addon/edit/closetag.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/edit/matchbrackets.d.ts b/types/codemirror/addon/edit/matchbrackets.d.ts index b663371160..e7c2f72065 100644 --- a/types/codemirror/addon/edit/matchbrackets.d.ts +++ b/types/codemirror/addon/edit/matchbrackets.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: Sixin Li // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/edit/matchtags.d.ts b/types/codemirror/addon/edit/matchtags.d.ts index 302e12d2d8..da6b1491f1 100644 --- a/types/codemirror/addon/edit/matchtags.d.ts +++ b/types/codemirror/addon/edit/matchtags.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/hint/show-hint.d.ts b/types/codemirror/addon/hint/show-hint.d.ts index 933b5c154b..90645d7bc1 100644 --- a/types/codemirror/addon/hint/show-hint.d.ts +++ b/types/codemirror/addon/hint/show-hint.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: jacqt // basarat diff --git a/types/codemirror/addon/runmode/runmode.d.ts b/types/codemirror/addon/runmode/runmode.d.ts index e08be74ee0..3f0b85ff43 100644 --- a/types/codemirror/addon/runmode/runmode.d.ts +++ b/types/codemirror/addon/runmode/runmode.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: Joseph Vaughan // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/scroll/scrollpastend.d.ts b/types/codemirror/addon/scroll/scrollpastend.d.ts index 4b83f011eb..880a082574 100644 --- a/types/codemirror/addon/scroll/scrollpastend.d.ts +++ b/types/codemirror/addon/scroll/scrollpastend.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/search/match-highlighter.d.ts b/types/codemirror/addon/search/match-highlighter.d.ts index 7705f071d8..2eaaf763f9 100644 --- a/types/codemirror/addon/search/match-highlighter.d.ts +++ b/types/codemirror/addon/search/match-highlighter.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/search/searchcursor.d.ts b/types/codemirror/addon/search/searchcursor.d.ts index 45112b0f7e..db96617a4f 100644 --- a/types/codemirror/addon/search/searchcursor.d.ts +++ b/types/codemirror/addon/search/searchcursor.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: jacqt // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/selection/active-line.d.ts b/types/codemirror/addon/selection/active-line.d.ts index 1902ff0e24..c46dc07550 100644 --- a/types/codemirror/addon/selection/active-line.d.ts +++ b/types/codemirror/addon/selection/active-line.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/codemirror/CodeMirror // Definitions by: ficristo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/addon/tern/tern.d.ts b/types/codemirror/addon/tern/tern.d.ts index 32a6f54e46..9d6f2f6756 100644 --- a/types/codemirror/addon/tern/tern.d.ts +++ b/types/codemirror/addon/tern/tern.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: Nikolaj Kappler // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/codemirror/index.d.ts b/types/codemirror/index.d.ts index 536598324c..23a0bdf269 100644 --- a/types/codemirror/index.d.ts +++ b/types/codemirror/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for CodeMirror +// Type definitions for codemirror // Project: https://github.com/marijnh/CodeMirror // Definitions by: mihailik // nrbernard diff --git a/types/codemirror/test/addon/display/autorefresh.ts b/types/codemirror/test/addon/display/autorefresh.ts new file mode 100644 index 0000000000..3799a2c253 --- /dev/null +++ b/types/codemirror/test/addon/display/autorefresh.ts @@ -0,0 +1,6 @@ +import * as CodeMirror from "codemirror"; +import "codemirror/addon/display/autorefresh"; + +const myCodeMirror: CodeMirror.Editor = CodeMirror(document.body, { + autoRefresh: true +}); diff --git a/types/codemirror/tsconfig.json b/types/codemirror/tsconfig.json index 08de263458..f101646675 100644 --- a/types/codemirror/tsconfig.json +++ b/types/codemirror/tsconfig.json @@ -22,6 +22,7 @@ "test/index.ts", "test/addon/comment/comment.ts", "test/addon/display/panel.ts", + "test/addon/display/autorefresh.ts", "test/addon/edit/closebrackets.ts", "test/addon/edit/closetag.ts", "test/addon/edit/matchbrackets.ts", @@ -34,4 +35,4 @@ "test/addon/selection/active-line.ts", "test/addon/tern/tern.ts" ] -} \ No newline at end of file +}