feat: add generic types for parser and renderer output by UziTech · Pull Request #3722 · markedjs/marked

UziTech · 2025-07-05T04:59:30Z

Marked version: 16.0.0

Description

Add Generic types for parser and renderer output. This allows for parsers that output something other than an html string.

See UziTech/marked-html-renderer#9 for an example on how this can be used to output HTML elements.

Contributor

Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
no tests required for this PR.
If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

CI is green (no forced merge required).
Squash and Merge PR following conventional commit guidelines.

vercel · 2025-07-05T04:59:36Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
marked-website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 5, 2025 6:03am

styfle · 2025-07-16T01:17:05Z

        case 'text': {
          let textToken = token;
-          let body = this.renderer.text(textToken);
+          let body = this.renderer.text(textToken) as string;


This as string seems like the types are wrong. Is there a way to improve it so we don't need the assertion 🤔

This is needed because the renderer is generic so at this point this.renderer.test() could return any type. We are assuming that the RendererOutput applies to all renderer functions so the user will have to change every function (including this one) if they want to return something other than a string. The correct way to type this would be to have a generic param for every renderer function. I feel like that is a bit overkill.

styfle · 2025-07-16T01:19:19Z

  };
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export let _defaults: MarkedOptions<any, any> = _getDefaults();


Why any? Is that because we don't want to pass in generic types to _getDefaults()?

If we mark this as anything else then _defaults would have to stay that type. But because we can specify different types for some options this has to be any because it can be anything.

# [16.1.0](v16.0.0...v16.1.0) (2025-07-17) ### Features * add generic types for parser and renderer output ([#3722](#3722)) ([39a0ee3](39a0ee3))

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [marked](https://marked.js.org) ([source](https://github.com/markedjs/marked)) | [`15.0.12` -> `16.2.0`](https://renovatebot.com/diffs/npm/marked/15.0.12/16.2.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/marked/16.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/marked/15.0.12/16.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>markedjs/marked (marked)</summary> ### [`v16.2.0`](https://github.com/markedjs/marked/releases/tag/v16.2.0) [Compare Source](markedjs/marked@v16.1.2...v16.2.0) ##### Features - add def token in tokens and renderer ([#3745](markedjs/marked#3745)) ([0769124](markedjs/marked@0769124)) ### [`v16.1.2`](https://github.com/markedjs/marked/releases/tag/v16.1.2) [Compare Source](markedjs/marked@v16.1.1...v16.1.2) ##### Bug Fixes - fix multiline list item adds extra newline to raw ([#3735](markedjs/marked#3735)) ([e76453e](markedjs/marked@e76453e)) ### [`v16.1.1`](https://github.com/markedjs/marked/releases/tag/v16.1.1) [Compare Source](markedjs/marked@v16.1.0...v16.1.1) ##### Bug Fixes - fix stong and em tokens in angle brackets ([#3731](markedjs/marked#3731)) ([ad8535c](markedjs/marked@ad8535c)) ### [`v16.1.0`](https://github.com/markedjs/marked/releases/tag/v16.1.0) [Compare Source](markedjs/marked@v16.0.0...v16.1.0) ##### Features - add generic types for parser and renderer output ([#3722](markedjs/marked#3722)) ([39a0ee3](markedjs/marked@39a0ee3)) ### [`v16.0.0`](https://github.com/markedjs/marked/releases/tag/v16.0.0) [Compare Source](markedjs/marked@v15.0.12...v16.0.0) ##### Bug Fixes - remove cjs build & update min node to 20 ([#3687](markedjs/marked#3687)) ([0a35d8f](markedjs/marked@0a35d8f)) ##### BREAKING CHANGES - minify ./lib/marked.esm.js and ./lib/marked.umd.js - remove ./marked.min.js use ./lib/marked.umd.js instead - remove ./lib/marked.cjs - update minimum supported node version to 20 to support `require('marked.esm.js')`. see https://nodejs.org/docs/latest-v20.x/api/modules.html#loading-ecmascript-modules-using-require </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (...

# [16.1.0](markedjs/marked@v16.0.0...v16.1.0) (2025-07-17) ### Features * add generic types for parser and renderer output ([#3722](markedjs/marked#3722)) ([8e2bbf6](markedjs/marked@8e2bbf6))

fix: add generic types for parser and renderer output

069ba41

vercel Bot deployed to Preview July 5, 2025 04:59 View deployment

UziTech closed this Jul 5, 2025

UziTech added 2 commits July 4, 2025 23:28

fix types

035b18e

rename generic variables

f4a8c71

UziTech reopened this Jul 5, 2025

vercel Bot deployed to Preview July 5, 2025 05:40 View deployment

add tests

cb2f05d

vercel Bot deployed to Preview July 5, 2025 06:03 View deployment

UziTech requested review from calculuschild and styfle July 5, 2025 06:04

UziTech mentioned this pull request Jul 5, 2025

fix: use typescript UziTech/marked-html-renderer#9

Merged

UziTech changed the title ~~fix: add generic types for parser and renderer output~~ feat: add generic types for parser and renderer output Jul 5, 2025

styfle reviewed Jul 16, 2025

View reviewed changes

styfle approved these changes Jul 17, 2025

View reviewed changes

UziTech merged commit 39a0ee3 into markedjs:master Jul 17, 2025
8 checks passed

github-actions Bot pushed a commit that referenced this pull request Jul 17, 2025

chore(release): 16.1.0 [skip ci]

eb3ad1a

# [16.1.0](v16.0.0...v16.1.0) (2025-07-17) ### Features * add generic types for parser and renderer output ([#3722](#3722)) ([39a0ee3](39a0ee3))

UziTech deleted the generic-parser branch March 6, 2026 23:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add generic types for parser and renderer output#3722

feat: add generic types for parser and renderer output#3722
UziTech merged 4 commits into
markedjs:masterfrom
UziTech:generic-parser

UziTech commented Jul 5, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Jul 5, 2025 •

edited

Loading

Uh oh!

styfle Jul 16, 2025

Uh oh!

UziTech Jul 16, 2025 •

edited

Loading

Uh oh!

styfle Jul 16, 2025

Uh oh!

UziTech Jul 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

UziTech commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Contributor

Committer

Uh oh!

vercel Bot commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

styfle Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

UziTech Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

styfle Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

UziTech Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

UziTech commented Jul 5, 2025 •

edited

Loading

vercel Bot commented Jul 5, 2025 •

edited

Loading

UziTech Jul 16, 2025 •

edited

Loading