class method `self.encode`

Ruby on Rails 8.1.2

Since v2.2.3

Available in: v2.2.3 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

self.encode(value, options = nil)

Dumps objects in JSON (JavaScript Object Notation). See www.json.org for more info.

ActiveSupport::JSON.encode({ team: 'rails', players: '36' })
# => "{\"team\":\"rails\",\"players\":\"36\"}"

By default, it generates JSON that is safe to include in JavaScript, as it escapes U+2028 (Line Separator) and U+2029 (Paragraph Separator):

ActiveSupport::JSON.encode({ key: "\u2028" })
# => "{\"key\":\"\\u2028\"}"

By default, it also generates JSON that is safe to include in HTML, as it escapes <, >, and &:

ActiveSupport::JSON.encode({ key: "<>&" })
# => "{\"key\":\"\\u003c\\u003e\\u0026\"}"

This behavior can be changed with the escape_html_entities option, or the global escape_html_entities_in_json configuration option.

ActiveSupport::JSON.encode({ key: "<>&" }, escape_html_entities: false)
# => "{\"key\":\"<>&\"}"

For performance reasons, you can set the escape option to false, which will skip all escaping:

ActiveSupport::JSON.encode({ key: "\u2028<>&" }, escape: false)
# => "{\"key\":\"\u2028<>&\"}"

Parameters

value req
options opt = nil

Source

# File activesupport/lib/active_support/json/encoding.rb, line 47
      def encode(value, options = nil)
        if options.nil? || options.empty?
          Encoding.encode_without_options(value)
        elsif options == { escape: false }.freeze
          Encoding.encode_without_escape(value)
        else
          Encoding.json_encoder.new(options).encode(value)
        end
      end

Defined in activesupport/lib/active_support/json/encoding.rb line 47 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::JSON

Signature

Parameters