{
  "schema_type": "object",
  "schema_version": "1.0",
  "name": "highlight",
  "path": "packages/ree_text/package/ree_text/functions/highlight.rb",
  "mount_as": "fn",
  "class": "ReeText::Highlight",
  "factory": null,
  "methods": [
    {
      "doc": "Highlights one or more +phrases+ everywhere in +text+ by inserting it into\na <tt>:highlighter</tt> string. The highlighter can be specialized by passing <tt>:highlighter</tt>\nas a single-quoted string with <tt>\u0001</tt> where the phrase is to be inserted (defaults to\n<tt><mark>\u0001</mark></tt>) or passing a block that receives each matched term. By default +text+\nis sanitized to prevent possible XSS attacks.If the input is trustworthy, passing false\nfor <tt>:sanitize</tt> will turn sanitizing off.\n\n  highlight('You searched for: rails', 'rails')\n  # => You searched for: <mark>rails</mark>\n\n  highlight('You searched for: rails', /for|rails/)\n  # => You searched <mark>for</mark>: <mark>rails</mark>\n\n  highlight('You searched for: ruby, rails, dhh', 'actionpack')\n  # => You searched for: ruby, rails, dhh\n\n  highlight('You searched for: rails', ['for', 'rails'], highlighter: '<em>\u0001</em>')\n  # => You searched <em>for</em>: <em>rails</em>\n\n  highlight('You searched for: rails', 'rails', highlighter: '<a href=\"search?q=\u0001\">\u0001</a>')\n  # => You searched for: <a href=\"search?q=rails\">rails</a>\n\n  highlight('You searched for: rails', 'rails') { |match| link_to(search_path(q: match, match)) }\n  # => You searched for: <a href=\"search?q=rails\">rails</a>\n\n  highlight('<a href=\"javascript:alert('no!')\">ruby</a> on rails', 'rails', sanitize: false)\n  # => <a href=\"javascript:alert('no!')\">ruby</a> on <mark>rails</mark>",
      "throws": [

      ],
      "return": "String",
      "args": [
        {
          "arg": "text",
          "type": "String"
        },
        {
          "arg": "phrases",
          "type": "Nilor[String, ArrayOf[String], Regexp]"
        },
        {
          "arg": "opts",
          "type": "Ksplat[:highlighter? => String, :sanitize? => Bool]"
        },
        {
          "arg": "block",
          "type": "Block"
        }
      ]
    }
  ],
  "links": [
    {
      "target": "sanitize_html",
      "package_name": "ree_text",
      "as": "sanitize_html",
      "imports": [

      ]
    }
  ]
}