marked 7.0.3 → 7.0.5

package/lib/marked.d.ts

@@ -1,8 +1,5 @@
 declare module "Tokens" {
-    export type Token = (Tokens.Space | Tokens.Code | Tokens.Heading | Tokens.Table | Tokens.Hr | Tokens.Blockquote | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.HTML | Tokens.Text | Tokens.Def | Tokens.Escape | Tokens.Tag | Tokens.Image | Tokens.Link | Tokens.Strong | Tokens.Em | Tokens.Codespan | Tokens.Br | Tokens.Del | Tokens.Generic) & {
-        loose?: boolean;
-        tokens?: Token[];
-    };
+    export type Token = (Tokens.Space | Tokens.Code | Tokens.Heading | Tokens.Table | Tokens.Hr | Tokens.Blockquote | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.HTML | Tokens.Text | Tokens.Def | Tokens.Escape | Tokens.Tag | Tokens.Image | Tokens.Link | Tokens.Strong | Tokens.Em | Tokens.Codespan | Tokens.Br | Tokens.Del | Tokens.Generic);
     export namespace Tokens {
         interface Space {
             type: 'space';
@@ -32,7 +29,7 @@ declare module "Tokens" {
         }
         interface TableCell {
             text: string;
-            tokens?: Token[];
+            tokens: Token[];
         }
         interface Hr {
             type: 'hr';
@@ -59,7 +56,7 @@ declare module "Tokens" {
             checked?: boolean | undefined;
             loose: boolean;
             text: string;
-            tokens?: Token[];
+            tokens: Token[];
         }
         interface Paragraph {
             type: 'paragraph';
@@ -306,6 +303,7 @@ declare module "Instance" {
     import type { MarkedExtension, MarkedOptions } from "MarkedOptions";
     import type { Token, TokensList } from "Tokens";
     export type ResultCallback = (error: Error | null, parseResult?: string) => undefined | void;
+    export type MaybePromise = void | Promise<void>;
     export class Marked {
         #private;
         defaults: MarkedOptions;
@@ -325,7 +323,7 @@ declare module "Instance" {
         /**
          * Run callback for every token
          */
-        walkTokens<T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]): T[];
+        walkTokens(tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]): MaybePromise[];
         use(...args: MarkedExtension[]): this;
         setOptions(opt: MarkedOptions): this;
     }
@@ -441,11 +439,13 @@ declare module "MarkedOptions" {
     export interface TokenizerThis {
         lexer: _Lexer;
     }
+    export type TokenizerExtensionFunction = (this: TokenizerThis, src: string, tokens: Token[] | TokensList) => Tokens.Generic | undefined;
+    export type TokenizerStartFunction = (this: TokenizerThis, src: string) => number | void;
     export interface TokenizerExtension {
         name: string;
         level: 'block' | 'inline';
-        start?: ((this: TokenizerThis, src: string) => number | void) | undefined;
-        tokenizer: (this: TokenizerThis, src: string, tokens: Token[] | TokensList) => Tokens.Generic | undefined;
+        start?: TokenizerStartFunction | undefined;
+        tokenizer: TokenizerExtensionFunction;
         childTokens?: string[] | undefined;
     }
     export interface RendererThis {
@@ -575,35 +575,36 @@ declare module "MarkedOptions" {
          */
         xhtml?: boolean | undefined;
     }
-    export interface MarkedOptions extends Omit<MarkedExtension, 'extensions' | 'renderer' | 'tokenizer' | 'walkTokens'> {
+    export interface MarkedOptions extends Omit<MarkedExtension, 'renderer' | 'tokenizer' | 'extensions' | 'walkTokens'> {
         /**
          * Type: object Default: new Renderer()
          *
          * An object containing functions to render tokens to HTML.
          */
-        renderer?: Omit<_Renderer, 'constructor'> | undefined | null;
+        renderer?: _Renderer | undefined | null;
         /**
          * The tokenizer defines how to turn markdown text into tokens.
          */
-        tokenizer?: Omit<_Tokenizer, 'constructor'> | undefined | null;
-        /**
-         * The walkTokens function gets called with every token.
-         * Child tokens are called before moving on to sibling tokens.
-         * Each token is passed by reference so updates are persisted when passed to the parser.
-         * The return value of the function is ignored.
-         */
-        walkTokens?: ((token: Token) => void | Promise<void> | Array<void | Promise<void>>) | undefined | null;
+        tokenizer?: _Tokenizer | undefined | null;
+        /**
+         * Custom extensions
+         */
+        extensions?: null | {
+            renderers: {
+                [name: string]: RendererExtensionFunction;
+            };
+            childTokens: {
+                [name: string]: string[];
+            };
+            inline?: TokenizerExtensionFunction[];
+            block?: TokenizerExtensionFunction[];
+            startInline?: TokenizerStartFunction[];
+            startBlock?: TokenizerStartFunction[];
+        };
         /**
-         * Add tokenizers and renderers to marked
+         * walkTokens function returns array of values for Promise.all
          */
-        extensions?: (TokenizerAndRendererExtension[] & {
-            renderers: Record<string, RendererExtensionFunction>;
-            childTokens: Record<string, string[]>;
-            block: any[];
-            inline: any[];
-            startBlock: Array<(this: TokenizerThis, src: string) => number | void>;
-            startInline: Array<(this: TokenizerThis, src: string) => number | void>;
-        }) | undefined | null;
+        walkTokens?: null | ((token: Token) => void | Promise<void> | (void | Promise<void>)[]);
     }
 }
 declare module "defaults" {
@@ -642,7 +643,7 @@ declare module "marked" {
     import { _getDefaults } from "defaults";
     import type { MarkedExtension, MarkedOptions } from "MarkedOptions";
     import type { Token, TokensList } from "Tokens";
-    import type { ResultCallback } from "Instance";
+    import type { ResultCallback, MaybePromise } from "Instance";
     /**
      * Compiles markdown to HTML asynchronously.
      *
@@ -689,7 +690,7 @@ declare module "marked" {
         var getDefaults: typeof _getDefaults;
         var defaults: MarkedOptions;
         var use: (...args: MarkedExtension[]) => typeof marked;
-        var walkTokens: <T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]) => T[];
+        var walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
         var parseInline: (src: string, optOrCallback?: MarkedOptions | ResultCallback | null | undefined, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
         var Parser: typeof _Parser;
         var parser: typeof _Parser.parse;
@@ -705,7 +706,7 @@ declare module "marked" {
     export const options: (options: MarkedOptions) => typeof marked;
     export const setOptions: (options: MarkedOptions) => typeof marked;
     export const use: (...args: MarkedExtension[]) => typeof marked;
-    export const walkTokens: <T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]) => T[];
+    export const walkTokens: (tokens: Token[] | TokensList, callback: (token: Token) => MaybePromise | MaybePromise[]) => MaybePromise[];
     export const parseInline: (src: string, optOrCallback?: MarkedOptions | ResultCallback | null | undefined, callback?: ResultCallback | undefined) => string | Promise<string | undefined> | undefined;
     export const parse: typeof marked;
     export const parser: typeof _Parser.parse;