nxt-highlightjs 22.0.0 → 22.1.0

package/types/nxt-highlightjs.d.ts

@@ -1,141 +1,167 @@
-import * as _angular_core from '@angular/core';
-import { InputSignal, WritableSignal, OutputEmitterRef, InjectionToken } from '@angular/core';
-import * as highlight_js from 'highlight.js';
-import { HighlightResult, AutoHighlightResult, HLJSApi, HLJSOptions, LanguageFn } from 'highlight.js';
-
-declare class HighlightJS {
-    private readonly loader;
-    readonly hljs: _angular_core.Signal<highlight_js.HLJSApi | undefined>;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HighlightJS, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<HighlightJS>;
+import { AutoHighlightResult, HLJSApi, HLJSOptions, HighlightResult, LanguageFn } from "highlight.js";
+import * as i0 from "@angular/core";
+import { InjectionToken, InputSignal, OutputEmitterRef, WritableSignal } from "@angular/core";
+export declare class HighlightJS {
+  private readonly loader;
+  readonly hljs: import("@angular/core").Signal<import("highlight.js").HLJSApi | undefined>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<HighlightJS, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
-declare abstract class HighlightBase {
-    protected readonly hljs: HighlightJS;
-    private readonly nativeElement;
-    private readonly sanitizer;
-    /**
-     * Code to highlight
-     */
-    abstract readonly code: InputSignal<string | undefined>;
-    /**
-     * Highlighted result
-     */
-    abstract readonly highlightResult: WritableSignal<HighlightResult | AutoHighlightResult | undefined>;
-    /**
-     * Stream that emits when code string is highlighted
-     */
-    abstract readonly highlighted: OutputEmitterRef<HighlightResult | AutoHighlightResult | undefined>;
-    constructor();
-    protected abstract highlightElement(code: string): HighlightResult | AutoHighlightResult | undefined;
-    private setTextContent;
-    private setInnerHTML;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HighlightBase, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<HighlightBase, never, never, {}, {}, never, never, true, never>;
+export declare abstract class HighlightBase {
+  protected readonly hljs: HighlightJS;
+  private readonly nativeElement;
+  private readonly sanitizer;
+  /**
+   * Code to highlight
+   */
+  abstract readonly code: InputSignal<string | undefined>;
+  /**
+   * Highlighted result
+   */
+  abstract readonly highlightResult: WritableSignal<HighlightResult | AutoHighlightResult | undefined>;
+  /**
+   * Stream that emits when code string is highlighted
+   */
+  abstract readonly highlighted: OutputEmitterRef<HighlightResult | AutoHighlightResult | undefined>;
+  constructor();
+  /**
+   * Highlights the code with the loaded Highlight.js, or returns `undefined` to show it as text
+   */
+  protected abstract highlightElement(code: string): HighlightResult | AutoHighlightResult | undefined;
+  private setTextContent;
+  private setInnerHTML;
+  static ɵfac: i0.ɵɵFactoryDeclaration<HighlightBase, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightBase, never, never, {}, {}, never, never, true, never>;
 }
-
-declare class HighlightAutoDirective extends HighlightBase {
-    /**
-     * Code to highlight
-     */
-    readonly code: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Highlighted result
-     */
-    readonly highlightResult: _angular_core.WritableSignal<AutoHighlightResult | undefined>;
-    /**
-     * An optional array of language names and aliases restricting detection to only those languages
-     *
-     * The subset can also be set with configure, but the local parameter overrides the option if set.
-     */
-    readonly languages: _angular_core.InputSignal<string[] | undefined>;
-    /**
-     * Stream that emits when code string is highlighted
-     */
-    readonly highlighted: _angular_core.OutputEmitterRef<AutoHighlightResult>;
-    protected highlightElement(code: string): AutoHighlightResult | undefined;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HighlightAutoDirective, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<HighlightAutoDirective, "[nxtHighlightAuto]", never, { "code": { "alias": "nxtHighlightAuto"; "required": false; "isSignal": true; }; "languages": { "alias": "languages"; "required": false; "isSignal": true; }; }, { "highlighted": "highlighted"; }, never, never, true, never>;
+export declare class HighlightAutoDirective extends HighlightBase {
+  /**
+   * Code to highlight
+   */
+  readonly code: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Highlighted result
+   */
+  readonly highlightResult: import("@angular/core").WritableSignal<AutoHighlightResult | undefined>;
+  /**
+   * An optional array of language names and aliases restricting detection to only those languages
+   *
+   * The subset can also be set with configure, but the local parameter overrides the option if set.
+   */
+  readonly languages: import("@angular/core").InputSignal<string[] | undefined>;
+  /**
+   * Stream that emits when code string is highlighted
+   */
+  readonly highlighted: import("@angular/core").OutputEmitterRef<AutoHighlightResult>;
+  protected highlightElement(code: string): AutoHighlightResult | undefined;
+  static ɵfac: i0.ɵɵFactoryDeclaration<HighlightAutoDirective, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightAutoDirective, "[nxtHighlightAuto]", never, {
+    "code": {
+      "alias": "nxtHighlightAuto";
+      "required": false;
+      "isSignal": true;
+    };
+    "languages": {
+      "alias": "languages";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "highlighted": "highlighted";
+  }, never, never, true, never>;
 }
-
-declare class HighlightDirective extends HighlightBase {
-    /**
-     * Code to highlight
-     */
-    readonly code: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Highlighted result
-     */
-    readonly highlightResult: _angular_core.WritableSignal<HighlightResult | undefined>;
-    /**
-     * The language name highlight only one language
-     */
-    readonly language: _angular_core.InputSignal<string>;
-    /**
-     * An optional flag, when set to true it forces highlighting to finish even in case of detecting
-     * illegal syntax for the language instead of throwing an exception
-     */
-    readonly ignoreIllegals: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
-    /**
-     * Stream that emits when code string is highlighted
-     */
-    readonly highlighted: _angular_core.OutputEmitterRef<HighlightResult>;
-    highlightElement(code: string): HighlightResult | undefined;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HighlightDirective, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<HighlightDirective, "[nxtHighlight]", never, { "code": { "alias": "nxtHighlight"; "required": false; "isSignal": true; }; "language": { "alias": "language"; "required": true; "isSignal": true; }; "ignoreIllegals": { "alias": "ignoreIllegals"; "required": false; "isSignal": true; }; }, { "highlighted": "highlighted"; }, never, never, true, never>;
+export declare class HighlightDirective extends HighlightBase {
+  /**
+   * Code to highlight
+   */
+  readonly code: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Highlighted result
+   */
+  readonly highlightResult: import("@angular/core").WritableSignal<HighlightResult | undefined>;
+  /**
+   * The language name highlight only one language
+   *
+   * Without it, or with a language that isn't loaded, the code shows as text.
+   */
+  readonly language: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * An optional flag, when set to true it forces highlighting to finish even in case of detecting
+   * illegal syntax for the language instead of throwing an exception
+   */
+  readonly ignoreIllegals: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
+  /**
+   * Stream that emits when code string is highlighted
+   */
+  readonly highlighted: import("@angular/core").OutputEmitterRef<HighlightResult>;
+  highlightElement(code: string): HighlightResult | undefined;
+  static ɵfac: i0.ɵɵFactoryDeclaration<HighlightDirective, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightDirective, "[nxtHighlight]", never, {
+    "code": {
+      "alias": "nxtHighlight";
+      "required": false;
+      "isSignal": true;
+    };
+    "language": {
+      "alias": "language";
+      "required": false;
+      "isSignal": true;
+    };
+    "ignoreIllegals": {
+      "alias": "ignoreIllegals";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "highlighted": "highlighted";
+  }, never, never, true, never>;
 }
-
-declare class HighlightLoader {
-    private readonly document;
-    private readonly options;
-    private readonly pendingTasks;
-    private _t;
-    readonly hljs: _angular_core.Resource<HLJSApi | undefined>;
-    private themeLinkElement?;
-    constructor();
-    /**
-     * Lazy-Load highlight.js library
-     */
-    private loadLibrary;
-    /**
-     * Lazy-load highlight.js languages
-     */
-    private loadLanguages;
-    /**
-     * Reload theme styles
-     */
-    setTheme(path: string): void;
-    /**
-     * Load theme
-     */
-    private loadTheme;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HighlightLoader, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<HighlightLoader>;
+export declare class HighlightLoader {
+  private readonly document;
+  private readonly options;
+  private readonly pendingTasks;
+  private _t;
+  readonly hljs: import("@angular/core").Resource<HLJSApi | undefined>;
+  private themeLinkElement?;
+  constructor();
+  /**
+   * Lazy-Load highlight.js library
+   */
+  private loadLibrary;
+  /**
+   * Lazy-load highlight.js languages
+   */
+  private loadLanguages;
+  /**
+   * Reload theme styles
+   */
+  setTheme(path: string): void;
+  /**
+   * Load theme
+   */
+  private loadTheme;
+  static ɵfac: i0.ɵɵFactoryDeclaration<HighlightLoader, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
 /**
  * Full documentation is available here https://highlightjs.readthedocs.io/en/latest/api.html
  */
-interface LineNumbersOptions {
-    startFrom?: number;
-    singleLine?: boolean;
+export interface LineNumbersOptions {
+  startFrom?: number;
+  singleLine?: boolean;
 }
-interface HighlightJSOptions {
-    highlightOptions?: Partial<HLJSOptions>;
-    lineNumbersOptions?: LineNumbersOptions;
-    languages?: Record<string, () => Promise<LanguageFn>>;
-    coreLibraryLoader?: () => Promise<HLJSApi>;
-    fullLibraryLoader?: () => Promise<HLJSApi>;
-    lineNumbersLoader?: () => Promise<{
-        activateLineNumbers: (document: Document) => (code: string, options?: LineNumbersOptions) => string;
-    }>;
-    themePath?: string;
+export interface HighlightJSOptions {
+  highlightOptions?: Partial<HLJSOptions>;
+  lineNumbersOptions?: LineNumbersOptions;
+  languages?: Record<string, () => Promise<LanguageFn>>;
+  coreLibraryLoader?: () => Promise<HLJSApi>;
+  fullLibraryLoader?: () => Promise<HLJSApi>;
+  lineNumbersLoader?: () => Promise<{
+    activateLineNumbers: (document: Document) => (code: string, options?: LineNumbersOptions) => string;
+  }>;
+  themePath?: string;
 }
 /**
  * @internal
  */
-declare const NXT_HIGHLIGHT_OPTIONS: InjectionToken<HighlightJSOptions>;
-declare function provideHighlightOptions(options: HighlightJSOptions): _angular_core.EnvironmentProviders;
-
-export { HighlightAutoDirective, HighlightBase, HighlightDirective, HighlightJS, HighlightLoader, NXT_HIGHLIGHT_OPTIONS, provideHighlightOptions };
-export type { HighlightJSOptions, LineNumbersOptions };
+export declare const NXT_HIGHLIGHT_OPTIONS: InjectionToken<HighlightJSOptions>;
+export declare function provideHighlightOptions(options: HighlightJSOptions): import("@angular/core").EnvironmentProviders;