helpers/wrap_tokens

Source: wrap_tokens.js:3


Static Methods

wrapTokens( Token: Token, type: String, container: Object, tokens?: Array.<Token>, ): Array.<Token>

Wrap array of tokens by specified container object.

Parameters

  • Token (Token) — markdown-it's Token class.
  • type (String) — Token type. It will be suffixed by _open / _close.
  • container (Object) — A container object to wrap tokens, includes tag name and attributes.
    • container.tag (String) — The name of container element.
    • container.open (Object, optional) — The object assigning to an opening token.
    • container.close (Object, optional) — The object assigning to a closing token.
  • tokens (Array.<Token>, optional, default: "[]") — Wrapping tokens.

Returns

  • Array.<Token> — Wrapped tokens.