{ "schema_type": "object", "ree_version": "0.1.0", "name": "number_to_rounded", "path": "packages/ree_number/package/ree_number/functions/number_to_rounded.rb", "mount_as": "fn", "class": "ReeNumber::NumberToRounded", "factory": null, "methods": [ { "doc": "Rounds Integer(Float, Rational, String) and converts to a String.\n\nThe +options+ parameter takes a hash of any of these keys: \n :precision, :significant, :strip_insignificant_zeros.\n\nPresicion is 3 by default.\n number_to_rounded(111.2346) # => \"111.235\"\n number_to_rounded(\"111.2346\") # => \"111.235\"\n number_to_rounded(\"111.2346\", precision: 20) # => \"111.23460000000000000000\"\n number_to_rounded(Rational(1112346, 10000) # => \"111.2346\"\n number_to_rounded(123987, precision: 3, significant: true) # => \"124000\"\n\n number_to_rounded(\n 5.3929, \n precision: 10, \n significant: true, \n strip_insignificant_zeros: true\n ) # => \"5.3929\"", "throws": [ ], "return": "String", "args": [ { "arg": "number", "type": "Or[Integer, Float, Rational, String]" }, { "arg": "opts", "type": "Ksplat[:precision? => Integer, :significant? => Bool, :strip_insignificant_zeros? => Bool, :round_mode? => Or[up, down, truncate, half_up, default, half_down, half_even, banker, ceiling, floor]]" } ] } ], "links": [ { "target": "digit_count", "package_name": "ree_number", "as": "digit_count", "imports": [ ] }, { "target": "number_to_delimited", "package_name": "ree_number", "as": "number_to_delimited", "imports": [ ] }, { "target": "round_helper", "package_name": "ree_number", "as": "round_helper", "imports": [ "ROUND_MODES" ] }, { "target": "slice", "package_name": "ree_hash", "as": "slice", "imports": [ ] } ] }