class JSON::Coder

JSON::Coder holds a parser and generator configuration.

module MyApp
  JSONC_CODER = JSON::Coder.new(
    allow_trailing_comma: true
  )
end

MyApp::JSONC_CODER.load(document)

Public Class Methods

new(options = nil, &block) click to toggle source

Argument options, if given, contains a Hash of options for both parsing and generating. See Parsing Options, and Generating Options.

For generation, the strict: true option is always set. When a Ruby object with no native JSON counterpart is encountered, the block provided to the initialize method is invoked, and must return a Ruby object that has a native JSON counterpart:

module MyApp
  API_JSON_CODER = JSON::Coder.new do |object|
    case object
    when Time
      object.iso8601(3)
    else
      object # Unknown type, will raise
    end
  end
end

puts MyApp::API_JSON_CODER.dump(Time.now.utc) # => "2025-01-21T08:41:44.286Z"

# File ext/json/lib/json/common.rb, line 1061
def initialize(options = nil, &as_json)
  if options.nil?
    options = { strict: true }
  else
    options = options.dup
    options[:strict] = true
  end
  options[:as_json] = as_json if as_json

  @state = State.new(options).freeze
  @parser_config = Ext::Parser::Config.new(ParserOptions.prepare(options)).freeze
end

Public Instance Methods

dump(object) → String click to toggle source

dump(object, io) → io

Serialize the given object into a JSON document.

# File ext/json/lib/json/common.rb, line 1079
def dump(object, io = nil)
  @state.generate(object, io)
end

Also aliased as: generate

generate(object, io = nil)

Alias for: dump

load(string) → Object click to toggle source

Parse the given JSON document and return an equivalent Ruby object.

# File ext/json/lib/json/common.rb, line 1088
def load(source)
  @parser_config.parse(source)
end

Also aliased as: parse

load(path) → Object click to toggle source

Parse the given JSON document and return an equivalent Ruby object.

# File ext/json/lib/json/common.rb, line 1097
def load_file(path)
  load(File.read(path, encoding: Encoding::UTF_8))
end

parse(source)

Alias for: load