@types/marked - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

marked/index.d.ts

@@ -56,11 +56,2 @@ // Type definitions for Marked 2.0
     /**
-     * @param src String of markdown source to be compiled
-     * @param links Array of links
-     * @param options Hash of options
-     * @return String of compiled HTML
-     */
-
-    function inlineLexer(src: string, links: string[], options?: MarkedOptions): string;
-
-    /**
      * Compiles markdown to HTML.
@@ -126,65 +117,59 @@ *
      * Use Extension
-     * @param Renderer
+     * @param MarkedExtension
      */
-    function use(options: MarkedOptions): void;
+    function use(options: MarkedExtension): void;
 
-    class InlineLexer {
-        constructor(links: string[], options?: MarkedOptions);
-        options: MarkedOptions;
-        links: string[];
-        rules: Rules;
-        renderer: Renderer;
-        static rules: Rules;
-        static output(src: string, links: string[], options?: MarkedOptions): string;
-        output(src: string): string;
-        static escapes(text: string): string;
-        outputLink(cap: string[], link: string): string;
-        smartypants(text: string): string;
-        mangle(text: string): string;
-    }
-
-    class Tokenizer {
+    class Tokenizer<T = never> {
         constructor(options?: MarkedOptions);
         options: MarkedOptions;
-        space(src: string): Tokens.Space;
-        code(src: string): Tokens.Code;
-        fences(src: string): Tokens.Code;
-        heading(src: string): Tokens.Heading;
-        nptable(src: string): Tokens.Table;
-        hr(src: string): Tokens.Hr;
-        blockquote(src: string): Tokens.Blockquote;
-        list(src: string): Tokens.List;
-        html(src: string): Tokens.HTML;
-        def(src: string): Tokens.Def;
-        table(src: string): Tokens.Table;
-        lheading(src: string): Tokens.Heading;
-        paragraph(src: string): Tokens.Paragraph;
-        text(src: string): Tokens.Text;
-        escape(src: string): Tokens.Escape;
-        tag(src: string, inLink: boolean, inRawBlock: boolean): Tokens.Tag;
-        link(src: string): Tokens.Image | Tokens.Link;
-        reflink(src: string, links: Tokens.Link[] | Tokens.Image[]): Tokens.Link | Tokens.Image | Tokens.Text;
-        emStrong(src: string, maskedSrc: string, prevChar: string): Tokens.Em | Tokens.Strong;
-        codespan(src: string): Tokens.Codespan;
-        br(src: string): Tokens.Br;
-        del(src: string): Tokens.Del;
-        autolink(src: string, mangle: (cap: string) => string): Tokens.Link;
-        url(src: string, mangle: (cap: string) => string): Tokens.Link;
-        inlineText(src: string, inRawBlock: boolean, smartypants: (cap: string) => string): Tokens.Text;
+        space(src: string): Tokens.Space | T;
+        code(src: string): Tokens.Code | T;
+        fences(src: string): Tokens.Code | T;
+        heading(src: string): Tokens.Heading | T;
+        nptable(src: string): Tokens.Table | T;
+        hr(src: string): Tokens.Hr | T;
+        blockquote(src: string): Tokens.Blockquote | T;
+        list(src: string): Tokens.List | T;
+        html(src: string): Tokens.HTML | T;
+        def(src: string): Tokens.Def | T;
+        table(src: string): Tokens.Table | T;
+        lheading(src: string): Tokens.Heading | T;
+        paragraph(src: string): Tokens.Paragraph | T;
+        text(src: string): Tokens.Text | T;
+        escape(src: string): Tokens.Escape | T;
+        tag(src: string, inLink: boolean, inRawBlock: boolean): Tokens.Tag | T;
+        link(src: string): Tokens.Image | Tokens.Link | T;
+        reflink(
+            src: string,
+            links: Tokens.Link[] | Tokens.Image[],
+        ): Tokens.Link | Tokens.Image | Tokens.Text | T;
+        emStrong(src: string, maskedSrc: string, prevChar: string): Tokens.Em | Tokens.Strong | T;
+        codespan(src: string): Tokens.Codespan | T;
+        br(src: string): Tokens.Br | T;
+        del(src: string): Tokens.Del | T;
+        autolink(src: string, mangle: (cap: string) => string): Tokens.Link | T;
+        url(src: string, mangle: (cap: string) => string): Tokens.Link | T;
+        inlineText(
+            src: string,
+            inRawBlock: boolean,
+            smartypants: (cap: string) => string,
+        ): Tokens.Text | T;
     }
 
-    class Renderer {
+    type TokenizerObject = Partial<Omit<Tokenizer<false>, "constructor" | "options">>;
+
+    class Renderer<T = never> {
         constructor(options?: MarkedOptions);
         options: MarkedOptions;
-        code(code: string, language: string | undefined, isEscaped: boolean): string;
-        blockquote(quote: string): string;
-        html(html: string): string;
-        heading(text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: Slugger): string;
-        hr(): string;
-        list(body: string, ordered: boolean, start: number): string;
-        listitem(text: string): string;
-        checkbox(checked: boolean): string;
-        paragraph(text: string): string;
-        table(header: string, body: string): string;
-        tablerow(content: string): string;
+        code(code: string, language: string | undefined, isEscaped: boolean): string | T;
+        blockquote(quote: string): string | T;
+        html(html: string): string | T;
+        heading(text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger: Slugger): string | T;
+        hr(): string | T;
+        list(body: string, ordered: boolean, start: number): string | T;
+        listitem(text: string): string | T;
+        checkbox(checked: boolean): string | T;
+        paragraph(text: string): string | T;
+        table(header: string, body: string): string | T;
+        tablerow(content: string): string | T;
         tablecell(
@@ -194,15 +179,17 @@ content: string,
                 header: boolean;
-                align: 'center' | 'left' | 'right' | null;
+                align: "center" | "left" | "right" | null;
             },
-        ): string;
-        strong(text: string): string;
-        em(text: string): string;
-        codespan(code: string): string;
-        br(): string;
-        del(text: string): string;
-        link(href: string | null, title: string | null, text: string): string;
-        image(href: string | null, title: string | null, text: string): string;
-        text(text: string): string;
+        ): string | T;
+        strong(text: string): string | T;
+        em(text: string): string | T;
+        codespan(code: string): string | T;
+        br(): string | T;
+        del(text: string): string | T;
+        link(href: string | null, title: string | null, text: string): string | T;
+        image(href: string | null, title: string | null, text: string): string | T;
+        text(text: string): string | T;
     }
 
+    type RendererObject = Partial<Omit<Renderer<false>, "constructor" | "options">>;
+
     class TextRenderer {
@@ -226,9 +213,9 @@ strong(text: string): string;
         renderer: Renderer;
+        textRenderer: TextRenderer;
         slugger: Slugger;
         static parse(src: TokensList, options?: MarkedOptions): string;
+        static parseInline(src: TokensList, options?: MarkedOptions): string;
         parse(src: TokensList): string;
+        parseInline(src: TokensList, renderer: Renderer): string;
         next(): Token;
-        peek(): Token | 0;
-        parseText(): string;
-        tok(): string;
     }
@@ -242,6 +229,8 @@
         static rules: Rules;
-        static lex(src: TokensList, options?: MarkedOptions): TokensList;
+        static lex(src: string, options?: MarkedOptions): TokensList;
+        static lexInline(src: string, options?: MarkedOptions): TokensList;
         lex(src: string): TokensList;
-        token(src: string, top: boolean): TokensList;
+        blockTokens(src: string, tokens: TokensList, top: boolean): TokensList;
         inline(tokens: TokensList): TokensList;
+        inlineTokens(src: string, tokens: TokensList, inLink: boolean, inRawBlock: boolean): TokensList;
     }
@@ -295,3 +284,3 @@
         interface Space {
-            type: 'space';
+            type: "space";
             raw: string;
@@ -301,5 +290,5 @@ }
         interface Code {
-            type: 'code';
+            type: "code";
             raw: string;
-            codeBlockStyle?: 'indented';
+            codeBlockStyle?: "indented";
             lang?: string;
@@ -310,3 +299,3 @@ text: string;
         interface Heading {
-            type: 'heading';
+            type: "heading";
             raw: string;
@@ -318,6 +307,6 @@ depth: number;
         interface Table {
-            type: 'table';
+            type: "table";
             raw: string;
             header: string[];
-            align: Array<'center' | 'left' | 'right' | null>;
+            align: Array<"center" | "left" | "right" | null>;
             cells: string[][];
@@ -327,3 +316,3 @@ }
         interface Hr {
-            type: 'hr';
+            type: "hr";
             raw: string;
@@ -333,3 +322,3 @@ }
         interface Blockquote {
-            type: 'blockquote';
+            type: "blockquote";
             raw: string;
@@ -340,3 +329,3 @@ text: string;
         interface BlockquoteStart {
-            type: 'blockquote_start';
+            type: "blockquote_start";
             raw: string;
@@ -346,3 +335,3 @@ }
         interface BlockquoteEnd {
-            type: 'blockquote_end';
+            type: "blockquote_end";
             raw: string;
@@ -352,3 +341,3 @@ }
         interface List {
-            type: 'list';
+            type: "list";
             raw: string;
@@ -362,3 +351,3 @@ ordered: boolean;
         interface ListItem {
-            type: 'list_item';
+            type: "list_item";
             raw: string;
@@ -372,3 +361,3 @@ task: boolean;
         interface Paragraph {
-            type: 'paragraph';
+            type: "paragraph";
             raw: string;
@@ -380,3 +369,3 @@ pre?: boolean;
         interface HTML {
-            type: 'html';
+            type: "html";
             raw: string;
@@ -388,3 +377,3 @@ pre: boolean;
         interface Text {
-            type: 'text';
+            type: "text";
             raw: string;
@@ -401,3 +390,3 @@ text: string;
         interface Escape {
-            type: 'escape';
+            type: "escape";
             raw: string;
@@ -408,3 +397,3 @@ text: string;
         interface Tag {
-            type: 'text' | 'html';
+            type: "text" | "html";
             raw: string;
@@ -417,3 +406,3 @@ inLink: boolean;
         interface Link {
-            type: 'link';
+            type: "link";
             raw: string;
@@ -427,3 +416,3 @@ href: string;
         interface Image {
-            type: 'image';
+            type: "image";
             raw: string;
@@ -436,3 +425,3 @@ href: string;
         interface Strong {
-            type: 'strong';
+            type: "strong";
             raw: string;
@@ -443,3 +432,3 @@ text: string;
         interface Em {
-            type: 'em';
+            type: "em";
             raw: string;
@@ -450,3 +439,3 @@ text: string;
         interface Codespan {
-            type: 'codespan';
+            type: "codespan";
             raw: string;
@@ -457,3 +446,3 @@ text: string;
         interface Br {
-            type: 'br';
+            type: "br";
             raw: string;
@@ -463,3 +452,3 @@ }
         interface Del {
-            type: 'del';
+            type: "del";
             raw: string;
@@ -470,3 +459,3 @@ text: string;
 
-    interface MarkedOptions {
+    interface MarkedExtension {
         /**
@@ -529,3 +518,3 @@ * A prefix URL for any relative link.
          */
-        renderer?: Renderer;
+        renderer?: Renderer | RendererObject;
 
@@ -560,3 +549,3 @@ /**
          */
-        tokenizer?: Tokenizer;
+        tokenizer?: Tokenizer | TokenizerObject;
 
@@ -575,2 +564,16 @@ /**
     }
+
+    interface MarkedOptions extends MarkedExtension {
+        /**
+         * Type: object Default: new Renderer()
+         *
+         * An object containing functions to render tokens to HTML.
+         */
+        renderer?: Renderer;
+
+        /**
+         * The tokenizer defines how to turn markdown text into tokens.
+         */
+        tokenizer?: Tokenizer;
+    }
 }

marked/package.json

 {
     "name": "@types/marked",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "description": "TypeScript definitions for Marked",
@@ -57,4 +57,4 @@ "license": "MIT",
     "dependencies": {},
-    "typesPublisherContentHash": "dab0ba347abdd82025508e549b9d24724c4f9bc7ec500fbe6d2d661a2dbcd254",
+    "typesPublisherContentHash": "1c4613bff018326b0801a587ba2015faae963f92744d2f19dcdfe5ad8cc82a49",
     "typeScriptVersion": "3.5"
 }

marked/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Sun, 07 Mar 2021 18:12:56 GMT
+ * Last updated: Tue, 30 Mar 2021 18:31:11 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@ * Global values: `marked`

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19885

increased by1.85%

Lines of code

479

increased by0.42%

No dependency changes