marked 13.0.2 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/marked.d.cts CHANGED
@@ -455,13 +455,8 @@ export interface MarkedExtension {
455
455
  * The return value of the function is ignored.
456
456
  */
457
457
  walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
458
- /**
459
- * Use the new renderer that accepts an object instead of individual parameters.
460
- * This option will be removed and default to true in the next major version.
461
- */
462
- useNewRenderer?: boolean | undefined;
463
458
  }
464
- export interface MarkedOptions extends Omit<MarkedExtension, "useNewRenderer" | "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
459
+ export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
465
460
  /**
466
461
  * Hooks are methods that hook into some part of marked.
467
462
  */
@@ -590,11 +585,26 @@ declare function _getDefaults(): MarkedOptions;
590
585
  declare let _defaults: MarkedOptions;
591
586
  export type MaybePromise = void | Promise<void>;
592
587
  export declare class Marked {
593
- #private;
594
588
  defaults: MarkedOptions;
595
589
  options: (opt: MarkedOptions) => this;
596
- parse: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
597
- parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
590
+ parse: {
591
+ (src: string, options: MarkedOptions & {
592
+ async: true;
593
+ }): Promise<string>;
594
+ (src: string, options: MarkedOptions & {
595
+ async: false;
596
+ }): string;
597
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
598
+ };
599
+ parseInline: {
600
+ (src: string, options: MarkedOptions & {
601
+ async: true;
602
+ }): Promise<string>;
603
+ (src: string, options: MarkedOptions & {
604
+ async: false;
605
+ }): string;
606
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
607
+ };
598
608
  Parser: typeof _Parser;
599
609
  Renderer: typeof _Renderer;
600
610
  TextRenderer: typeof _TextRenderer;
@@ -610,6 +620,8 @@ export declare class Marked {
610
620
  setOptions(opt: MarkedOptions): this;
611
621
  lexer(src: string, options?: MarkedOptions): TokensList;
612
622
  parser(tokens: Token[], options?: MarkedOptions): string;
623
+ private parseMarkdown;
624
+ private onError;
613
625
  }
614
626
  /**
615
627
  * Compiles markdown to HTML asynchronously.
@@ -628,7 +640,13 @@ export declare function marked(src: string, options: MarkedOptions & {
628
640
  * @param options Optional hash of options
629
641
  * @return String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.
630
642
  */
631
- export declare function marked(src: string, options?: MarkedOptions): string | Promise<string>;
643
+ export declare function marked(src: string, options: MarkedOptions & {
644
+ async: false;
645
+ }): string;
646
+ export declare function marked(src: string, options: MarkedOptions & {
647
+ async: true;
648
+ }): Promise<string>;
649
+ export declare function marked(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
632
650
  export declare namespace marked {
633
651
  var options: (options: MarkedOptions) => typeof marked;
634
652
  var setOptions: (options: MarkedOptions) => typeof marked;
@@ -636,7 +654,15 @@ export declare namespace marked {
636
654
  var defaults: MarkedOptions;
637
655
  var use: (...args: MarkedExtension[]) => typeof marked;
638
656
  var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
639
- var parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
657
+ var parseInline: {
658
+ (src: string, options: MarkedOptions & {
659
+ async: true;
660
+ }): Promise<string>;
661
+ (src: string, options: MarkedOptions & {
662
+ async: false;
663
+ }): string;
664
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
665
+ };
640
666
  var Parser: typeof _Parser;
641
667
  var parser: typeof _Parser.parse;
642
668
  var Renderer: typeof _Renderer;
@@ -651,7 +677,15 @@ export declare const options: (options: MarkedOptions) => typeof marked;
651
677
  export declare const setOptions: (options: MarkedOptions) => typeof marked;
652
678
  export declare const use: (...args: MarkedExtension[]) => typeof marked;
653
679
  export declare const walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
654
- export declare const parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
680
+ export declare const parseInline: {
681
+ (src: string, options: MarkedOptions & {
682
+ async: true;
683
+ }): Promise<string>;
684
+ (src: string, options: MarkedOptions & {
685
+ async: false;
686
+ }): string;
687
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
688
+ };
655
689
  export declare const parse: typeof marked;
656
690
  export declare const parser: typeof _Parser.parse;
657
691
  export declare const lexer: typeof _Lexer.lex;
package/lib/marked.d.ts CHANGED
@@ -455,13 +455,8 @@ export interface MarkedExtension {
455
455
  * The return value of the function is ignored.
456
456
  */
457
457
  walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
458
- /**
459
- * Use the new renderer that accepts an object instead of individual parameters.
460
- * This option will be removed and default to true in the next major version.
461
- */
462
- useNewRenderer?: boolean | undefined;
463
458
  }
464
- export interface MarkedOptions extends Omit<MarkedExtension, "useNewRenderer" | "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
459
+ export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
465
460
  /**
466
461
  * Hooks are methods that hook into some part of marked.
467
462
  */
@@ -590,11 +585,26 @@ declare function _getDefaults(): MarkedOptions;
590
585
  declare let _defaults: MarkedOptions;
591
586
  export type MaybePromise = void | Promise<void>;
592
587
  export declare class Marked {
593
- #private;
594
588
  defaults: MarkedOptions;
595
589
  options: (opt: MarkedOptions) => this;
596
- parse: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
597
- parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
590
+ parse: {
591
+ (src: string, options: MarkedOptions & {
592
+ async: true;
593
+ }): Promise<string>;
594
+ (src: string, options: MarkedOptions & {
595
+ async: false;
596
+ }): string;
597
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
598
+ };
599
+ parseInline: {
600
+ (src: string, options: MarkedOptions & {
601
+ async: true;
602
+ }): Promise<string>;
603
+ (src: string, options: MarkedOptions & {
604
+ async: false;
605
+ }): string;
606
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
607
+ };
598
608
  Parser: typeof _Parser;
599
609
  Renderer: typeof _Renderer;
600
610
  TextRenderer: typeof _TextRenderer;
@@ -610,6 +620,8 @@ export declare class Marked {
610
620
  setOptions(opt: MarkedOptions): this;
611
621
  lexer(src: string, options?: MarkedOptions): TokensList;
612
622
  parser(tokens: Token[], options?: MarkedOptions): string;
623
+ private parseMarkdown;
624
+ private onError;
613
625
  }
614
626
  /**
615
627
  * Compiles markdown to HTML asynchronously.
@@ -628,7 +640,13 @@ export declare function marked(src: string, options: MarkedOptions & {
628
640
  * @param options Optional hash of options
629
641
  * @return String of compiled HTML. Will be a Promise of string if async is set to true by any extensions.
630
642
  */
631
- export declare function marked(src: string, options?: MarkedOptions): string | Promise<string>;
643
+ export declare function marked(src: string, options: MarkedOptions & {
644
+ async: false;
645
+ }): string;
646
+ export declare function marked(src: string, options: MarkedOptions & {
647
+ async: true;
648
+ }): Promise<string>;
649
+ export declare function marked(src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
632
650
  export declare namespace marked {
633
651
  var options: (options: MarkedOptions) => typeof marked;
634
652
  var setOptions: (options: MarkedOptions) => typeof marked;
@@ -636,7 +654,15 @@ export declare namespace marked {
636
654
  var defaults: MarkedOptions;
637
655
  var use: (...args: MarkedExtension[]) => typeof marked;
638
656
  var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
639
- var parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
657
+ var parseInline: {
658
+ (src: string, options: MarkedOptions & {
659
+ async: true;
660
+ }): Promise<string>;
661
+ (src: string, options: MarkedOptions & {
662
+ async: false;
663
+ }): string;
664
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
665
+ };
640
666
  var Parser: typeof _Parser;
641
667
  var parser: typeof _Parser.parse;
642
668
  var Renderer: typeof _Renderer;
@@ -651,7 +677,15 @@ export declare const options: (options: MarkedOptions) => typeof marked;
651
677
  export declare const setOptions: (options: MarkedOptions) => typeof marked;
652
678
  export declare const use: (...args: MarkedExtension[]) => typeof marked;
653
679
  export declare const walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
654
- export declare const parseInline: (src: string, options?: MarkedOptions | undefined | null) => string | Promise<string>;
680
+ export declare const parseInline: {
681
+ (src: string, options: MarkedOptions & {
682
+ async: true;
683
+ }): Promise<string>;
684
+ (src: string, options: MarkedOptions & {
685
+ async: false;
686
+ }): string;
687
+ (src: string, options?: MarkedOptions | undefined | null): string | Promise<string>;
688
+ };
655
689
  export declare const parse: typeof marked;
656
690
  export declare const parser: typeof _Parser.parse;
657
691
  export declare const lexer: typeof _Lexer.lex;