(chore) declare ambient modules for lib/core & languges

highlightjs · Jun 16, 2020 · a4ee4e4 · a4ee4e4
1 parent 0656588
commit a4ee4e4
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/src/highlight.js b/src/highlight.js
@@ -20,6 +20,7 @@ const NO_MATCH = Symbol("nomatch");
 
 /**
  * @param {any} hljs - object that is extended (legacy)
+ * @returns {HLJSApi}
  */
 const HLJS = function(hljs) {
   // Convenience variables for build-in objects

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -210,3 +210,22 @@ interface ModeDetails {
     subLanguage?: string | string[]
     compiled?: boolean
 }
+
+// deprecated API since v10
+// declare module 'highlight.js/lib/highlight.js';
+
+declare module 'highlight.js' {
+    export = hljs;
+}
+
+declare module 'highlight.js/lib/core' {
+    export = hljs;
+}
+
+declare module 'highlight.js/lib/core.js' {
+    export = hljs;
+}
+
+declare module 'highlight.js/lib/languages/*' {
+    export default function(hljs?: HLJSApi): LanguageDetail;
+}