@types/showdown
Advanced tools
Comparing version 1.9.0 to 1.9.1
// Type definitions for Showdown 1.9.0 | ||
// Project: https://github.com/coreyti/showdown | ||
// Definitions by: cbowdon <https://github.com/cbowdon>, Pei-Tang Huang <https://github.com/tan9>, Ariel-Saldana <https://github.com/arielsaldana> | ||
// Project: https://github.com/showdownjs/showdown | ||
// Definitions by: Hamed Baatour <https://github.com/hamedbaatour>, | ||
// cbowdon <https://github.com/cbowdon>, | ||
// Pei-Tang Huang <https://github.com/tan9>, | ||
// Ariel-Saldana <https://github.com/arielsaldana> | ||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
@@ -67,2 +70,6 @@ | ||
interface Metadata { | ||
[meta: string]: string; | ||
} | ||
interface ShowdownOptions { | ||
@@ -283,2 +290,39 @@ /** | ||
backslashEscapesHTMLTags?: boolean; | ||
/** | ||
* Enable emoji support. Ex: `this is a :smile: emoji. | ||
* | ||
* @default false | ||
*/ | ||
emoji?: boolean; | ||
/** | ||
* Enable support for underline. Syntax is double or triple underscores: `__underline word__`. With this option enabled, | ||
* underscores no longer parses into `<em>` and `<strong>` | ||
* | ||
* @default false | ||
*/ | ||
underline?: boolean; | ||
/** | ||
* Outputs a complete html document, including `<html>`, `<head>` and `<body>` tags | ||
* | ||
* @default false | ||
*/ | ||
completeHTMLDocument?: boolean; | ||
/** | ||
* Outputs a complete html document, including `<html>`, `<head>` and `<body>` tags | ||
* | ||
* @default false | ||
*/ | ||
metadata?: boolean; | ||
/** | ||
* Split adjacent blockquote blocks | ||
* | ||
* @default false | ||
*/ | ||
splitAdjacentBlockquotes?: boolean; | ||
} | ||
@@ -301,7 +345,7 @@ | ||
* Converts an HTML string into a markdown string | ||
* | ||
* @param src The input text (HTML) | ||
* @returns The output markdown | ||
* @param src | ||
* @param [HTMLParser] A WHATWG DOM and HTML parser, such as JSDOM. If none is supplied, window.document will be used. | ||
* @returns {string} | ||
*/ | ||
makeMarkdown(src: string): string; | ||
makeMarkdown(src: string, HTMLParser?: any): string; | ||
@@ -366,4 +410,17 @@ /** | ||
*/ | ||
setFlavor(name: string): void; | ||
setFlavor(name: 'github' | 'original' | 'ghost' | 'vanilla' | 'allOn'): void; | ||
/** | ||
* Get the metadata of the previously parsed document | ||
* @param raw | ||
* @returns {string|{}} | ||
*/ | ||
getMetadata(raw?: boolean): string | Metadata | ||
/** | ||
* Get the metadata format of the previously parsed document | ||
* @returns {string} | ||
*/ | ||
getMetadataFormat(): string; | ||
} | ||
@@ -484,3 +541,3 @@ | ||
*/ | ||
function setFlavor(name: string): void; | ||
function setFlavor(name: 'github' | 'original' | 'ghost' | 'vanilla' | 'allOn'): void; | ||
} |
{ | ||
"name": "@types/showdown", | ||
"version": "1.9.0", | ||
"version": "1.9.1", | ||
"description": "TypeScript definitions for Showdown", | ||
@@ -8,2 +8,7 @@ "license": "MIT", | ||
{ | ||
"name": "Hamed Baatour", | ||
"url": "https://github.com/hamedbaatour", | ||
"githubUsername": "hamedbaatour" | ||
}, | ||
{ | ||
"name": "cbowdon", | ||
@@ -32,4 +37,4 @@ "url": "https://github.com/cbowdon", | ||
"dependencies": {}, | ||
"typesPublisherContentHash": "be4bc83ffa3c4296476622bb94b05b888f796bf81f407f5db591a394130c4d29", | ||
"typesPublisherContentHash": "99888c9a454bbc07034a68f2dd94fb936b7e990cab916bb8f6ebf93582ff761d", | ||
"typeScriptVersion": "2.0" | ||
} |
@@ -5,3 +5,3 @@ # Installation | ||
# Summary | ||
This package contains type definitions for Showdown (https://github.com/coreyti/showdown). | ||
This package contains type definitions for Showdown (https://github.com/showdownjs/showdown). | ||
@@ -12,3 +12,3 @@ # Details | ||
Additional Details | ||
* Last updated: Tue, 18 Dec 2018 23:36:04 GMT | ||
* Last updated: Mon, 07 Jan 2019 17:06:21 GMT | ||
* Dependencies: none | ||
@@ -18,2 +18,2 @@ * Global values: showdown | ||
# Credits | ||
These definitions were written by cbowdon <https://github.com/cbowdon>, Pei-Tang Huang <https://github.com/tan9>, Ariel-Saldana <https://github.com/arielsaldana>. | ||
These definitions were written by Hamed Baatour <https://github.com/hamedbaatour>, cbowdon <https://github.com/cbowdon>, Pei-Tang Huang <https://github.com/tan9>, Ariel-Saldana <https://github.com/arielsaldana>. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
18274
463