PHPXRef 0.7.1 : WordPress : Detail view of blocks.js

Given block children, returns a serialize-capable WordPress element.

return: {WPElement} A serialize-capable element.
param: {WPBlockChildren} children Block children object to convert.

getChildrenArray(children) X-Ref

Given block children, returns an array of block nodes.

return: {Array<WPBlockNode>} An array of individual block nodes.
param: {WPBlockChildren} children Block children object to convert.

concat() X-Ref

Given two or more block nodes, returns a new block node representing a
concatenation of its values.

return: {WPBlockChildren} Concatenated block node.
param: {...WPBlockChildren} blockNodes Block nodes to concatenate.

fromDOM(domNodes) X-Ref

Given an iterable set of DOM nodes, returns equivalent block children.
Ignores any non-element/text nodes included in set.

return: {WPBlockChildren} Block children equivalent to DOM nodes.
param: {Iterable.<Node>} domNodes Iterable set of DOM nodes to convert.

toHTML(children) X-Ref

Given a block node, returns its HTML string representation.

return: {string} String HTML representation of block node.
param: {WPBlockChildren} children Block node(s) to convert to string.

matcher(selector) X-Ref

Given a selector, returns an hpq matcher generating a WPBlockChildren value
matching the selector result.

return: {Function} hpq matcher.
param: {string} selector DOM selector.

createBlock(name) X-Ref

Returns a block object given its type and attributes.

return: {Object} Block object.
param: {string} name Block name.
param: {Object} blockAttributes Block attributes.
param: {?Array} innerBlocks Nested blocks.

cloneBlock(block) X-Ref

Given a block object, returns a copy of the block object, optionally merging
new attributes and/or replacing its inner blocks.

return: {Object} A cloned block.
param: {Object} block              Block object.
param: {Object} mergeAttributes    Block attributes.
param: {?Array} newInnerBlocks     Nested blocks.

getPossibleBlockTransformations(blocks) X-Ref

Returns an array of block types that the set of blocks received as argument
can be transformed into.

return: {Array} Block types that the blocks argument can be transformed to.
param: {Array} blocks Blocks array.

findTransform(transforms, predicate) X-Ref

Given an array of transforms, returns the highest-priority transform where
the predicate function returns a truthy value. A higher-priority transform
is one with a lower priority value (i.e. first in priority order). Returns
null if the transforms set is empty or the predicate function returns a
falsey value for all entries.

return: {?Object} Highest-priority transform candidate.
param: {Object[]} transforms Transforms to search.
param: {Function} predicate Function returning true on matching transform.

getBlockTransforms(direction, blockName) X-Ref

Returns normal block transforms for a given transform direction, optionally
for a specific block by name, or an empty array if there are no transforms.
If no block name is provided, returns transforms for all blocks. A normal
transform object includes `blockName` as a property.

return: {Array} Block transforms for direction.
param: {string} direction Transform direction ("to", "from").
param: {?string} blockName Optional block name.

switchToBlockType(blocks, name) X-Ref

Switch one or more blocks into one or more blocks of the new block type.

return: {Array} Array of blocks.
param: {Array|Object} blocks Blocks array or block object.
param: {string} name Block name.

html(selector, multilineTag) X-Ref

No description

isNodeOfType(node, type) X-Ref

Given a single node and a node type (e.g. `'br'`), returns true if the node
corresponds to that type, false otherwise.

return: {boolean} Whether node is of intended type.
param: {WPBlockNode} node Block node to test
param: {string} type Node to type to test against.

getNamedNodeMapAsObject(nodeMap) X-Ref

Given an object implementing the NamedNodeMap interface, returns a plain
object equivalent value of name, value key-value pairs.

return: {Object} Object equivalent value of NamedNodeMap.
param: {NamedNodeMap} nodeMap NamedNodeMap to convert to object.

fromDOM(domNode) X-Ref

Given a DOM Element or Text node, returns an equivalent block node. Throws
if passed any node type other than element or text.

return: {WPBlockNode} Block node equivalent to DOM node.
param: {Node} domNode DOM node to convert.

toHTML(node) X-Ref

Given a block node, returns its HTML string representation.

return: {string} String HTML representation of block node.
param: {WPBlockNode} node Block node to convert to string.

matcher(selector) X-Ref

Given a selector, returns an hpq matcher generating a WPBlockNode value
matching the selector result.

return: {Function} hpq matcher.
param: {string} selector DOM selector.

isOfType(value, type) X-Ref

No description

isOfTypes(value, types) X-Ref

Returns true if value is of an array of given JSON schema types, or false
otherwise.

return: {boolean} Whether value is of types.
param: {*} value Value to test.
param: {string[]} types Types to test.

isAmbiguousStringSource(attributeSchema) X-Ref

Returns true if the given attribute schema describes a value which may be
an ambiguous string.

Some sources are ambiguously serialized as strings, for which value casting
is enabled. This is only possible when a singular type is assigned to the
attribute schema, since the string ambiguity makes it impossible to know the
correct type of multiple to which to cast.

return: {boolean} Whether attribute schema defines an ambiguous string
param: {Object} attributeSchema Attribute's schema.

asType(value, type) X-Ref

Returns value coerced to the specified JSON schema type string.

return: {*} Coerced value.
param: {*} value Original value.
param: {string} type Type to coerce.

matcherFromSource(sourceConfig) X-Ref

Returns an hpq matcher given a source object.

return: {Function} A hpq Matcher.
param: {Object} sourceConfig Attribute Source object.

parseWithAttributeSchema(innerHTML, attributeSchema) X-Ref

Given a block's raw content and an attribute's schema returns the attribute's
value depending on its source.

return: {*} Attribute value.
param: {string} innerHTML Block's raw content.
param: {Object} attributeSchema Attribute's schema.

getBlockAttribute(attributeKey, attributeSchema, innerHTML, commentAttributes) X-Ref

Given an attribute key, an attribute's schema, a block's raw content and the
commentAttributes returns the attribute value depending on its source
definition of the given attribute key.

return: {*} Attribute value.
param: {string} attributeKey      Attribute key.
param: {Object} attributeSchema   Attribute's schema.
param: {string} innerHTML         Block's raw content.
param: {Object} commentAttributes Block's comment attributes.

getBlockAttributes(blockType, innerHTML, attributes) X-Ref

Returns the block attributes of a registered block node given its type.

return: {Object} All block attributes.
param: {?Object} blockType Block type.
param: {string} innerHTML Raw block content.
param: {?Object} attributes Known block attributes (from delimiters).

getMigratedBlock(block) X-Ref

Given a block object, returns a new copy of the block with any applicable
deprecated migrations applied, or the original block if it was both valid
and no eligible migrations exist.

return: {WPBlock} Migrated block object.
param: {WPBlock} block Original block object.

createBlockWithFallback(blockNode) X-Ref

Creates a block with fallback to the unknown type handler.

return: {?Object} An initialized block object (if possible).
param: {Object} blockNode Parsed block node.

isFigureContent(node, schema) X-Ref

Whether or not the given node is figure content.

return: {boolean} True if figure content, false if not.
param: {Node} node The node to check.
param: {Object} schema The schema to use.

canHaveAnchor(node, schema) X-Ref

Whether or not the given node can have an anchor.

return: {boolean} True if it can, false if not.
param: {Node} node The node to check.
param: {Object} schema The schema to use.

filterInlineHTML(HTML) X-Ref

Filters HTML to only contain phrasing content.

return: {string} HTML only containing phrasing content.
param: {string} HTML The HTML to filter.

getRawTransformations() X-Ref

No description

rawHandler(_ref) X-Ref

Converts an HTML string to known blocks. Strips everything else.

return: {Array|string} A list of blocks or a string, depending on `handlerMode`.
param: {string}  [options.HTML]                     The HTML to convert.
param: {string}  [options.plainText]                Plain text version.
param: {string}  [options.mode]                     Handle content as blocks or inline content.
param: {Array}   [options.tagName]                  The tag into which content will be inserted.
param: {boolean} [options.canUserUseUnfilteredHTML] Whether or not the user can use unfiltered HTML.

isInline(node, contextTag) X-Ref

Checks if the given node should be considered inline content, optionally
depending on a context tag.

return: {boolean} True if the node is inline content, false if nohe.
param: {Node} node Node name.
param: {string} contextTag Tag name.

deepCheck(nodes, contextTag) X-Ref

No description

isDoubleBR(node) X-Ref

No description

isList(node) X-Ref

WordPress dependencies

shallowTextContent(element) X-Ref

No description

slackMarkdownVariantCorrector(text) X-Ref

Corrects the Slack Markdown variant of the code block.
If uncorrected, it will be converted to inline code.

return: {string} The corrected Markdown.
param: {string} text The potential Markdown text to correct.

isList(node) X-Ref

No description

isBlockContent(node) X-Ref

No description

getPhrasingContentSchema() X-Ref

Get schema of possible paths for phrasing content.

return: {Object} Schema.

isPhrasingContent(node) X-Ref

Find out whether or not the given node is phrasing content.

return: {boolean} True if phrasing content, false if not.
param: {Element} node The node to test.

segmentHTMLToShortcodeBlock(HTML) X-Ref

No description

createMore(customText, noTeaser, doc) X-Ref

No description

createNextpage(doc) X-Ref

No description

getBlockContentSchema(transforms) X-Ref

Given raw transforms from blocks, merges all schemas into one.

return: {Object} A complete block content schema.
param: {Array} transforms Block transforms, of the `raw` type.

isEmpty(element) X-Ref

Recursively checks if an element is empty. An element is not empty if it
contains text or contains elements with attributes such as images.

return: {boolean} Wether or not the element is empty.
param: {Element} element The element to check.

isPlain(HTML) X-Ref

Checks wether HTML can be considered plain text. That is, it does not contain
any elements that are not line breaks.

return: {boolean} Wether the HTML can be considered plain text.
param: {string} HTML The HTML to check.

deepFilterNodeList(nodeList, filters, doc, schema) X-Ref

Given node filters, deeply filters and mutates a NodeList.

param: {NodeList} nodeList The nodeList to filter.
param: {Array}    filters  An array of functions that can mutate with the provided node.
param: {Document} doc      The document of the nodeList.
param: {Object}   schema   The schema to use.

deepFilterHTML(HTML) X-Ref

Given node filters, deeply filters HTML tags.
Filters from the deepest nodes to the top.

return: {string} The filtered HTML.
param: {string} HTML    The HTML to filter.
param: {Array}  filters An array of functions that can mutate with the provided node.
param: {Object} schema  The schema to use.

cleanNodeList(nodeList, doc, schema, inline) X-Ref

Given a schema, unwraps or removes nodes, attributes and classes on a node
list.

param: {NodeList} nodeList The nodeList to filter.
param: {Document} doc      The document of the nodeList.
param: {Object}   schema   An array of functions that can mutate with the provided node.
param: {Object}   inline   Whether to clean for inline mode.

removeInvalidHTML(HTML, schema, inline) X-Ref

Given a schema, unwraps or removes nodes, attributes and classes on HTML.

return: {string} The cleaned up HTML.
param: {string} HTML The HTML to clean up.
param: {Object} schema Schema for the HTML.
param: {Object} inline Whether to clean for inline mode.

unstable__bootstrapServerSideBlockDefinitions(definitions) X-Ref

Set the server side block definition of blocks.

param: {Object} definitions Server-side block definitions

registerBlockType(name, settings) X-Ref

Registers a new block provided a unique name and an object defining its
behavior. Once registered, the block is made available as an option to any
editor interface where blocks are implemented.

return: {?WPBlock} The block, if it has been successfully registered;
param: {string} name Block name.
param: {Object} settings Block settings.

unregisterBlockType(name) X-Ref

Unregisters a block.

return: {?WPBlock} The previous block value, if it has been successfully
param: {string} name Block name.

setUnknownTypeHandlerName(name) X-Ref

Assigns name of block handling unknown block types.

param: {string} name Block name.

getUnknownTypeHandlerName() X-Ref

Retrieves name of block handling unknown block types, or undefined if no
handler has been defined.

return: {?string} Blog name.

setFreeformContentHandlerName(name) X-Ref

Assigns name of block for handling non-block content.

param: {string} name Block name.

getFreeformContentHandlerName() X-Ref

Retrieves name of block handling non-block content, or undefined if no
handler has been defined.

return: {?string} Blog name.

setUnregisteredTypeHandlerName(name) X-Ref

Assigns name of block handling unregistered block types.

param: {string} name Block name.

getUnregisteredTypeHandlerName() X-Ref

Retrieves name of block handling unregistered block types, or undefined if no
handler has been defined.

return: {?string} Blog name.

setDefaultBlockName(name) X-Ref

Assigns the default block name.

param: {string} name Block name.

getDefaultBlockName() X-Ref

Retrieves the default block name.

return: {?string} Block name.

getBlockType(name) X-Ref

Returns a registered block type.

return: {?Object} Block type.
param: {string} name Block name.

getBlockTypes() X-Ref

Returns all registered blocks.

return: {Array} Block settings.

getBlockSupport(nameOrType, feature, defaultSupports) X-Ref

Returns the block support value for a feature, if defined.

return: {?*} Block support value
param: {(string|Object)} nameOrType      Block name or type object
param: {string}          feature         Feature to retrieve
param: {*}               defaultSupports Default value to return if not

hasBlockSupport(nameOrType, feature, defaultSupports) X-Ref

Returns true if the block defines support for a feature, or false otherwise.

return: {boolean} Whether block supports feature.
param: {(string|Object)} nameOrType      Block name or type object.
param: {string}          feature         Feature to test.
param: {boolean}         defaultSupports Whether feature is supported by

isReusableBlock(blockOrType) X-Ref

Determines whether or not the given block is a reusable block. This is a
special block type that is used to point to a global block stored via the
API.

return: {boolean} Whether the given block is a reusable block.
param: {Object} blockOrType Block or Block Type to test.

getBlockDefaultClassName(blockName) X-Ref

Returns the block's default classname from its name.

return: {string} The block's default class.
param: {string} blockName The block name.

getBlockMenuDefaultClassName(blockName) X-Ref

Returns the block's default menu item classname from its name.

return: {string} The block's default menu item class.
param: {string} blockName The block name.

getSaveElement(blockType, attributes) X-Ref

Given a block type containing a save render implementation and attributes, returns the
enhanced element to be saved or string when raw HTML expected.

return: {Object|string} Save element or raw HTML string.
param: {Object} blockType Block type.
param: {Object} attributes Block attributes.
param: {?Array} innerBlocks Nested blocks.

getSaveContent(blockType, attributes, innerBlocks) X-Ref

Given a block type containing a save render implementation and attributes, returns the
static markup to be saved.

return: {string} Save content.
param: {Object} blockType Block type.
param: {Object} attributes Block attributes.
param: {?Array} innerBlocks Nested blocks.

getCommentAttributes(allAttributes, blockType) X-Ref

Returns attributes which are to be saved and serialized into the block
comment delimiter.

When a block exists in memory it contains as its attributes both those
parsed the block comment delimiter _and_ those which matched from the
contents of the block.

This function returns only those attributes which are needed to persist and
which cannot be matched from the block content.

return: {Object<string,*>} Subset of attributes for comment serialization.
param: {Object<string,*>} allAttributes Attributes from in-memory block data.
param: {Object<string,*>} blockType Block type.

serializeAttributes(attributes) X-Ref

Given an attributes object, returns a string in the serialized attributes
format prepared for post content.

return: {string} Serialized attributes.
param: {Object} attributes Attributes object.

getBlockContent(block) X-Ref

Given a block object, returns the Block's Inner HTML markup.

return: {string} HTML.
param: {Object} block Block Object.

getCommentDelimitedContent(rawBlockName, attributes, content) X-Ref

Returns the content of a block, including comment delimiters.

return: {string} Comment-delimited block content.
param: {string} rawBlockName Block name.
param: {Object} attributes Block attributes.
param: {string} content Block save content.

serializeBlock(block) X-Ref

Returns the content of a block, including comment delimiters, determining
serialized attributes and content form from the current state of the block.

return: {string} Serialized block.
param: {Object} block Block instance.

serialize(blocks) X-Ref

Takes a block or set of blocks and returns the serialized post content.

return: {string} The post content.
param: {Array} blocks Block(s) to serialize.

doBlocksMatchTemplate() X-Ref

Checks whether a list of blocks matches a template by comparing the block names.

return: {boolean}        Whether the list of blocks matches a templates
param: {Array} blocks    Block list.
param: {Array} template  Block template.

synchronizeBlocksWithTemplate() X-Ref

Synchronize a block list with a block template.

Synchronizing a block list with a block template means that we loop over the blocks
keep the block as is if it matches the block at the same position in the template
(If it has the same name) and if doesn't match, we create a new block based on the template.
Extra blocks not present in the template are removed.

return: {Array}          Updated Block list.
param: {Array} blocks    Block list.
param: {Array} template  Block template.

isUnmodifiedDefaultBlock(block) X-Ref

Determines whether the block is a default block
and its attributes are equal to the default attributes
which means the block is unmodified.

return: {boolean} Whether the block is an unmodified default block
param: {WPBlock} block Block Object

isValidIcon(icon) X-Ref

Function that checks if the parameter is a valid icon.

return: {boolean} True if the parameter is a valid icon and false otherwise.
param: {*} icon Parameter to be checked.

normalizeIconObject(icon) X-Ref

Function that receives an icon as set by the blocks during the registration
and returns a new icon object that is normalized so we can rely on just on possible icon structure
in the codebase.

return: {Object} Object describing the icon.
param: {(Object|string|WPElement)} icon Slug of the Dashicon to be shown

createLogger(logger) X-Ref

Creates a logger with block validation prefix.

return: {Function} Augmented logger function.
param: {Function} logger Original logger function.

getTextPiecesSplitOnWhitespace(text) X-Ref

Given a specified string, returns an array of strings split by consecutive
whitespace, ignoring leading or trailing whitespace.

return: {string[]} Text pieces split on whitespace.
param: {string} text Original text.

getTextWithCollapsedWhitespace(text) X-Ref

Given a specified string, returns a new trimmed string where all consecutive
whitespace is collapsed to a single space.

return: {string} Trimmed text with consecutive whitespace collapsed.
param: {string} text Original text.

getMeaningfulAttributePairs(token) X-Ref

Returns attribute pairs of the given StartTag token, including only pairs
where the value is non-empty or the attribute is a boolean attribute, an
enumerated attribute, or a custom data- attribute.

return: {Array[]} Attribute pairs.
param: {Object} token StartTag token.

isEqualTextTokensWithCollapsedWhitespace(actual, expected) X-Ref

Returns true if two text tokens (with `chars` property) are equivalent, or
false otherwise.

return: {boolean} Whether two text tokens are equivalent.
param: {Object} actual Actual token.
param: {Object} expected Expected token.

getNormalizedStyleValue(value) X-Ref

Given a style value, returns a normalized style value for strict equality
comparison.

return: {string} Normalized style value.
param: {string} value Style value.

getStyleProperties(text) X-Ref

Given a style attribute string, returns an object of style properties.

return: {Object} Style properties.
param: {string} text Style attribute.

isEqualTagAttributePairs(actual, expected) X-Ref

Given two sets of attribute tuples, returns true if the attribute sets are
equivalent.

return: {boolean} Whether attributes are equivalent.
param: {Array[]} actual Actual attributes tuples.
param: {Array[]} expected Expected attributes tuples.

getNextNonWhitespaceToken(tokens) X-Ref

Given an array of tokens, returns the first token which is not purely
whitespace.

Mutates the tokens array.

return: {Object} Next non-whitespace token.
param: {Object[]} tokens Set of tokens to search.

getHTMLTokens(html) X-Ref

Tokenize an HTML string, gracefully handling any errors thrown during
underlying tokenization.

return: {Object[]|null} Array of valid tokenized HTML elements, or null on error
param: {string} html HTML string to tokenize.

isEquivalentHTML(actual, expected) X-Ref

Returns true if the given HTML strings are effectively equivalent, or
false otherwise. Invalid HTML is not considered equivalent, even if the
strings directly match.

return: {boolean} Whether HTML strings are equivalent.
param: {string} actual Actual HTML string.
param: {string} expected Expected HTML string.

isValidBlock(innerHTML, blockType, attributes) X-Ref

Returns true if the parsed block is valid given the input content. A block
is considered valid if, when serialized with assumed attributes, the content
matches the original value.

Logs to console in development environments when invalid.

return: {boolean} Whether block is valid.
param: {string} innerHTML Original block content.
param: {string} blockType Block type.
param: {Object} attributes Parsed block attributes.

addBlockTypes(blockTypes) X-Ref

Returns an action object used in signalling that block types have been added.

return: {Object} Action object.
param: {Array|Object} blockTypes Block types received.

removeBlockTypes(names) X-Ref

Returns an action object used to remove a registered block type.

return: {Object} Action object.
param: {string|Array} names Block name.

setDefaultBlockName(name) X-Ref

Returns an action object used to set the default block name.

return: {Object} Action object.
param: {string} name Block name.

setFallbackBlockName(name) X-Ref

Returns an action object used to set the name of the block used as a fallback
for non-block content.

return: {Object} Action object.
param: {string} name Block name.

setFreeformFallbackBlockName(name) X-Ref

Returns an action object used to set the name of the block used as a fallback
for non-block content.

return: {Object} Action object.
param: {string} name Block name.

setUnregisteredFallbackBlockName(name) X-Ref

Returns an action object used to set the name of the block used as a fallback
for unregistered blocks.

return: {Object} Action object.
param: {string} name Block name.

setCategories(categories) X-Ref

Returns an action object used to set block categories.

return: {Object} Action object.
param: {Object[]} categories Block categories.

blockTypes() X-Ref

Reducer managing the block types

return: {Object} Updated state.
param: {Object} state Current state.
param: {Object} action Dispatched action.

createBlockNameSetterReducer(setActionType) X-Ref

Higher-order Reducer creating a reducer keeping track of given block name.

return: {function} Reducer.
param: {string} setActionType Action type.

categories() X-Ref

Reducer managing the categories

return: {Object} Updated state.
param: {Object} state Current state.
param: {Object} action Dispatched action.

getBlockType(state, name) X-Ref

Returns a block type by name.

return: {Object?} Block Type.
param: {Object} state Data state.
param: {string} name Block type name.

getCategories(state) X-Ref

Returns all the available categories.

return: {Array} Categories list.
param: {Object} state Data state.

getDefaultBlockName(state) X-Ref

Returns the name of the default block name.

return: {string?} Default block name.
param: {Object} state Data state.

getFallbackBlockName(state) X-Ref

Returns the name of the fallback block name.

return: {string?} Fallback block name.
param: {Object} state Data state.

getFreeformFallbackBlockName(state) X-Ref

Returns the name of the block for handling non-block content.

return: {string?} Name of the block for handling non-block content.
param: {Object} state Data state.

getUnregisteredFallbackBlockName(state) X-Ref

Returns the name of the block for handling unregistered blocks.

return: {string?} Name of the block for handling unregistered blocks.
param: {Object} state Data state.

hasBlockSupport(state, nameOrType, feature, defaultSupports) X-Ref

Returns true if the block defines support for a feature, or false otherwise.

return: {boolean} Whether block supports feature.
param: {Object}         state           Data state.
param: {(string|Object)} nameOrType      Block name or type object.
param: {string}          feature         Feature to test.
param: {boolean}         defaultSupports Whether feature is supported by

getPath(object, path) X-Ref

Given object and string of dot-delimited path segments, returns value at
path or undefined if path cannot be resolved.

return: {?*} Resolved value
param: {Object} object Lookup object
param: {string} path Path to resolve

parse(source, matchers) X-Ref

Given a markup string or DOM element, creates an object aligning with the
shape of the matchers object, or the value returned by the matcher.

return: {(Object|*)} Matched value(s), shaped by object
param: {(string|Element)} source Source content
param: {(Object|Function)} matchers Matcher function or object of matchers

prop(selector, name) X-Ref

Generates a function which matches node of type selector, returning an
attribute by property if the attribute exists. If no selector is passed,
returns property of the query element.

return: {*} Property value
param: {?string} selector Optional selector
param: {string} name Property name

attr(selector, name) X-Ref

Generates a function which matches node of type selector, returning an
attribute by name if the attribute exists. If no selector is passed,
returns attribute of the query element.

return: {?string} Attribute value
param: {?string} selector Optional selector
param: {string} name Attribute name

html(selector) X-Ref

Convenience for `prop( selector, 'innerHTML' )`.

return: {string} Inner HTML
param: {?string} selector Optional selector

text(selector) X-Ref

Convenience for `prop( selector, 'textContent' )`.

return: {string} Text content
param: {?string} selector Optional selector

query(selector, matchers) X-Ref

Creates a new matching context by first finding elements matching selector
using querySelectorAll before then running another `parse` on `matchers`
scoped to the matched elements.

return: {Array.<*,Object>} Array of matched value(s)
param: {string} selector Selector to match
param: {(Object|Function)} matchers Matcher function or object of matchers

arrayOf( value ) X-Ref

Returns the first argument as the sole entry in an array.

return: {Array} Value returned as entry in array.
param: {*} value Value to return.

isObjectLike( value ) X-Ref

Returns true if the value passed is object-like, or false otherwise. A value
is object-like if it can support property assignment, e.g. object or array.

return: {boolean} Whether value is object-like.
param: {*} value Value to test.

createCache() X-Ref

Creates and returns a new cache object.

return: {Object} Cache object.

isShallowEqual( a, b, fromIndex ) X-Ref

Returns true if entries within the two arrays are strictly equal by
reference from a starting index.

return: {boolean} Whether arrays are shallowly equal.
param: {Array} a First array.
param: {Array} b Second array.
param: {number} fromIndex Index from which to start comparison.

getRootCache() X-Ref

Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( dependants ) X-Ref

Returns the cache for a given dependants array. When possible, a WeakMap
will be used to create a unique cache for each set of dependants. This
is feasible due to the nature of WeakMap in allowing garbage collection
to occur on entries where the key object is no longer referenced. Since
WeakMap requires the key to be an object, this is only possible when the
dependant is object-like. The root cache is created as a hierarchy where
each top-level key is the first entry in a dependants set, the value a
WeakMap where each key is the next dependant, and so on. This continues
so long as the dependants are object-like. If no dependants are object-
like, then the cache is shared across all invocations.

return: {Object} Cache object.
param: {Array} dependants Selector dependants.

clear() X-Ref

Resets root memoization cache.

callSelector( ) X-Ref

The augmented selector call, considering first whether dependants have
changed before passing it to underlying memoize function.

return: {*} Selector result.
param: {Object} source Source object for derivation.
param: {...*} extraArgs Additional arguments to pass to selector.

getDefaultOpts(simple) X-Ref

Created by Tivie on 13-07-2015.

allOptionsOn() X-Ref

No description

validate(extension, name) X-Ref

Validate extension

returns: {{valid: boolean, error: string}}
param: {array} extension
param: {string} name

escapeCharactersCallback(wholeMatch, m1) X-Ref

No description

_constructor() X-Ref

No description

_parseExtension(ext, name) X-Ref

Parse extension

param: {*} ext
param: {string} [name='']

legacyExtensionLoading(ext, name) X-Ref

LEGACY_SUPPORT

param: {*} ext
param: {string} name

listen(name, callback) X-Ref

Listen to an event

param: {string} name
param: {function} callback

rTrimInputText(text) X-Ref

No description

clean(node) X-Ref

No description

substitutePreCodeTags(doc) X-Ref

No description

hashHTMLSpan(html) X-Ref

No description

headerId(m) X-Ref

No description

writeImageTagBase64(wholeMatch, altText, linkId, url, width, height, m5, title) X-Ref

No description

writeImageTag(wholeMatch, altText, linkId, url, width, height, m5, title) X-Ref

No description

parseInside(txt, left, right) X-Ref

No description

processListItems(listStr, trimTrailing) X-Ref

Process the contents of a single ordered or unordered list, splitting it
into individual list items.

returns: {string}
param: {string} listStr
param: {boolean} trimTrailing

styleStartNumber(list, listType) X-Ref

No description

parseConsecutiveLists(list, listType, trimTrailing) X-Ref

Check and parse consecutive lists (better fix for issue #142)

returns: {string}
param: {string} list
param: {string} listType
param: {boolean} trimTrailing

parseMetadataContents(content) X-Ref

No description

parseInside(txt) X-Ref

No description

parseStyles(sLine) X-Ref

No description

parseHeaders(header, style) X-Ref

No description

parseCells(cell, style) X-Ref

No description

buildTable(headers, cells) X-Ref

No description