add some comments

This commit is contained in:
Philipp Kühn
2020-10-27 13:19:23 +01:00
parent 9fdb57cacb
commit 350e34f389
2 changed files with 10 additions and 0 deletions

View File

@@ -7,6 +7,10 @@ import {
ExtensionAttribute,
} from '../types'
/**
* Get a list of all extension attributes defined in `addAttribute` and `addGlobalAttribute`.
* @param extensions List of extensions
*/
export default function getAttributesFromExtensions(extensions: Extensions) {
const extensionAttributes: ExtensionAttribute[] = []
const { nodeExtensions, markExtensions } = splitExtensions(extensions)

View File

@@ -1,6 +1,12 @@
import { ParseRule } from 'prosemirror-model'
import { ExtensionAttribute } from '../types'
/**
* This function merges extension attributes into parserule attributes (`attrs` or `getAttrs`).
* Cancels when `getAttrs` returned `false`.
* @param parseRule ProseMirror ParseRule
* @param extensionAttributes List of attributes to inject
*/
export default function injectExtensionAttributesToParseRule(parseRule: ParseRule, extensionAttributes: ExtensionAttribute[]): ParseRule {
if (parseRule.style) {
return parseRule