@atlaskit/editor-jira-transformer
Version:
Editor JIRA transformer's
81 lines (62 loc) • 1.81 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/editor-jira-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';
import { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
// @public (undocumented)
export interface ContextInfo {
// (undocumented)
baseUrl: string;
// (undocumented)
clientId: string;
// (undocumented)
collection: string;
// (undocumented)
token: string;
}
// @public (undocumented)
export type CustomEncoder = (userId: string) => string;
// @public (undocumented)
export interface JIRACustomEncoders {
// (undocumented)
mention?: CustomEncoder;
}
// @public (undocumented)
export class JIRATransformer implements Transformer_2<string> {
constructor(
schema: Schema,
customEncoders?: JIRACustomEncoders,
mediaContextInfo?: MediaContextInfo,
);
// (undocumented)
encode(node: Node_2): string;
// (undocumented)
parse(html: string): Node_2;
}
// @public (undocumented)
export interface MediaContextInfo {
// (undocumented)
uploadContext?: ContextInfo;
// (undocumented)
viewContext?: ContextInfo;
}
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
### Peer Dependencies
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0"
}
```
<!--SECTION END: Peer Dependencies-->