Installations

npm install @types/json2md

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

152

Total

61,832

Closed

9,749

Merged

51,931

Issues

Open

565

Total

8,085

Closed

7,520

Releases

1

0.1.450

Updated on Sep 04, 2019

View All 1 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.84%)

JavaScript (0.15%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

NOASSERTION License

50,050 Stars

89,752 Commits

30,434 Forks

640 Watchers

6 Branches

9,957 Contributors

Updated on Jul 16, 2025

Maintainers

1

View All 9,957 Contributors

Package Meta Information

Latest Version

1.5.4

Package Id

@types/json2md@1.5.4

Unpacked Size

5.86 kB

Size

1.99 kB

File Count

5

Published on

Nov 07, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Installation

npm install --save @types/json2md

Summary

This package contains type definitions for json2md (https://github.com/IonicaBizau/json2md#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json2md.

index.d.ts

1export = json2md;
2
3/**
4 * Converts a JSON input to markdown.
5 *
6 * @param data The input JSON data.
7 * @param prefix A snippet to add before each line.
8 * @return The generated markdown result.
9 */
10declare function json2md(data: json2md.DataObject | json2md.DataObject[] | string | string[], prefix?: string): string;
11type json2md = typeof json2md;
12
13declare namespace json2md {
14    const converters: ConvertersMethods;
15
16    namespace DefaultConverters {
17        interface Converters {
18            [converter: string]: any;
19            blockquote: string | string[];
20            code: CodeInput;
21            h1: string | string[];
22            h2: string | string[];
23            h3: string | string[];
24            h4: string | string[];
25            h5: string | string[];
26            h6: string | string[];
27            img: ImgInput | ImgInput[];
28            ol: string[];
29            p: string | string[];
30            table: TableInput;
31            ul: string[];
32        }
33
34        interface ImgInput {
35            title: string;
36            source: string;
37        }
38
39        interface CodeInput {
40            language?: string | undefined;
41            content: string | string[];
42        }
43
44        interface TableInput {
45            headers: string[];
46            rows: Array<{ [column: string]: string }> | string[][];
47        }
48    }
49
50    type DataObject = {
51        [TConverter in keyof DefaultConverters.Converters]?: DefaultConverters.Converters[TConverter];
52    };
53
54    type ConverterCallback<TInput> = (input: TInput, json2md: json2md) => string;
55
56    type ConvertersMethods = {
57        [TConverter in keyof DefaultConverters.Converters]: ConverterCallback<DefaultConverters.Converters[TConverter]>;
58    };
59}
60

Additional Details

Last updated: Tue, 07 Nov 2023 03:09:37 GMT
Dependencies: none

Credits

These definitions were written by MartynasZilinskas.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More