class Crest::FlatParamsEncoder

Defined in:

crest/params_encoders/flat_params_encoder.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from class Crest::ParamsEncoder

encode(params : Hash) : String encode

Class methods inherited from class Crest::ParamsEncoder

encode(params : Hash) : String encode, flatten_params(object : JSON::Any, parent_key : String | Nil = nil) : Array(Tuple(String, Crest::ParamsValue)) flatten_params

Class Method Detail

def self.flatten_params(object : Hash, parent_key : String | Nil = nil) : Array(Tuple(String, Crest::ParamsValue)) #

Transform deeply nested params containers into a flat array of {key, value}.

parent_key — Should not be passed (used for recursion)

Crest::FlatParamsEncoder.flatten_params({:key1 => {:key2 => "123"}})
# => [{"key1[key2]", "123"}]

[View source]
def self.flatten_params(object : Array, parent_key : String | Nil = nil) : Array(Tuple(String, Crest::ParamsValue)) #

Transform deeply nested params containers into a flat array of {key, value}.

parent_key — Should not be passed (used for recursion)

Crest::FlatParamsEncoder.flatten_params({:key1 => {:arr => ["1", "2", "3"]}})
# => [{"key1[arr][]", "1"}, {"key1[arr][]", "2"}, {"key1[arr][]", "3"}]

[View source]

Instance Method Detail

def encode(params : Hash) : String #

Converts the given params into a URI query string. Keys and values will converted to strings and appropriately escaped for the URI.

Crest::FlatParamsEncoder.encode({"a" => ["one", "two", "three"], "b" => true, "c" => "C", "d" => 1})
# => 'a[]=one&a[]=two&a[]=three&b=true&c=C&d=1'

[View source]