@types/mdast
Advanced tools
TypeScript definitions for mdast
The @types/mdast package provides TypeScript definitions for MDAST, a syntax tree format for Markdown documents. This allows developers to work with Markdown documents in a structured way, leveraging TypeScript's type checking for better code reliability and developer experience. It's primarily used in projects where Markdown processing is involved, and TypeScript is the preferred language.
Node Type Definitions
Defines the structure of various Markdown AST nodes, such as documents (Root), paragraphs (Paragraph), and text (Text). This is useful for creating or manipulating Markdown documents programmatically.
{"import { Root, Paragraph, Text } from 'mdast';
const root: Root = {
type: 'root',
children: [{
type: 'paragraph',
children: [{
type: 'text',
value: 'Hello, world!'
}]
}]
};"}Type Guards
Provides type guards to assert node types at runtime, facilitating the implementation of type-safe operations on Markdown AST nodes.
{"import { isRoot, isParagraph } from 'mdast';
function processNode(node: Node) {
if (isRoot(node)) {
console.log('Processing root node');
} else if (isParagraph(node)) {
console.log('Processing paragraph node');
}
}"}Remark is a comprehensive Markdown processing ecosystem built on unified. It can parse, transform, and stringify Markdown documents. While @types/mdast provides type definitions for MDAST nodes, remark uses these structures to perform operations on Markdown documents, making them complementary.
Unified is an interface for processing text using syntax trees, serving as the foundation for remark and rehype ecosystems. It deals with abstract syntax trees (ASTs) for various formats, including MDAST for Markdown. Unlike @types/mdast, which only provides types, unified provides a framework for parsing, transforming, and serializing text.
Rehype is part of the unified ecosystem, focusing on HTML processing. It's similar to remark but for HTML documents. While @types/mdast provides TypeScript definitions for Markdown syntax trees, rehype deals with HTML syntax trees (HAST). Both are used for structured document processing in their respective domains.
npm install --save @types/mdast
This package contains type definitions for mdast (https://github.com/syntax-tree/mdast).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mdast.
These definitions were written by Christian Murphy, Jun Lu, Remco Haszing, Titus Wormer, and Remco Haszing.
FAQs
TypeScript definitions for mdast
We found that @types/mdast demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.