UNPKG

@atlaskit/editor-wikimarkup-transformer

Version:

Wiki markup transformer for JIRA and Confluence

100 lines (80 loc) 2.25 kB
<!-- API Report Version: 2.3 --> ## API Report File for "@atlaskit/editor-wikimarkup-transformer" > Do not edit this file. This report is auto-generated using > [API Extractor](https://api-extractor.com/). > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports) ### Table of contents - [Main Entry Types](#main-entry-types) - [Peer Dependencies](#peer-dependencies) ### Main Entry Types <!--SECTION START: Main Entry Types--> ```ts import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model'; import { Schema } from '@atlaskit/editor-prosemirror/model'; // @public (undocumented) interface Context { // (undocumented) readonly conversion?: { readonly inlineCardConversion?: ConversionMap; readonly mediaConversion?: MediaConversionMap; mentionConversion?: ConversionMap; }; // (undocumented) readonly defaults?: { readonly media?: { width: null | number; height: null | number; }; }; // (undocumented) readonly hydration?: { readonly media?: { targetCollectionId?: string; }; }; // (undocumented) readonly issueKeyRegex?: RegExp | undefined; // (undocumented) readonly tokenErrCallback?: TokenErrCallback; } // @public (undocumented) interface ConversionMap { // (undocumented) [key: string]: string; } // @public (undocumented) interface MediaConversionMap { // (undocumented) [key: string]: { transform?: string; embed?: boolean; }; } // @public (undocumented) type TokenErrCallback = (err: Error, tokenType: string) => void; // @public (undocumented) interface Transformer_2<T> { // (undocumented) encode(node: Node_2): T; // (undocumented) parse(content: T): Node_2; } // @public (undocumented) class WikiMarkupTransformer implements Transformer_2<string> { constructor(schema?: Schema); // (undocumented) encode(node: Node_2, context?: Context): string; // (undocumented) parse(wikiMarkup: string, context?: Context): Node_2; } export { WikiMarkupTransformer }; export default WikiMarkupTransformer; // (No @packageDocumentation comment for this package) ``` <!--SECTION END: Main Entry Types--> ### Peer Dependencies <!--SECTION START: Peer Dependencies--> ```json {} ``` <!--SECTION END: Peer Dependencies-->