Sha256: 8c71497fb7fca80a230a4f3b316815ecce8ab0cf7423dbc1111b9813c1d8acb9

Contents?: true

Size: 1.42 KB

Versions: 28

Compression:

Stored size: 1.42 KB

Contents

{
  "schema_type": "object",
  "schema_version": "1.0",
  "name": "truncate",
  "path": "packages/ree_string/package/ree_string/functions/truncate.rb",
  "mount_as": "fn",
  "class": "ReeString::Truncate",
  "factory": null,
  "methods": [
    {
      "doc": "Truncates a given +text+ after a given <tt>length</tt> if +text+ is longer than <tt>length</tt>:\n\n  truncate('Once upon a time in a world far far away', 27)\n  => \"Once upon a time in a wo...\"\n\nPass a string or regexp <tt>:separator</tt> to truncate +text+ at a natural break:\n\n  truncate('Once upon a time in a world far far away', 27, separator: ' ')\n  => \"Once upon a time in a...\"\n\n  truncate('Once upon a time in a world far far away', 27, separator: / /)\n  => \"Once upon a time in a...\"\n\nThe last characters will be replaced with the <tt>:omission</tt> string (defaults to \"...\")\nfor a total length not exceeding <tt>length</tt>:\n\n  truncate('And they found that many people were sleeping better.', 25, omission: '... (continued)')\n  => \"And they f... (continued)\"",
      "throws": [

      ],
      "return": "String",
      "args": [
        {
          "arg": "str",
          "type": "String"
        },
        {
          "arg": "truncate_at",
          "type": "Integer"
        },
        {
          "arg": "opts",
          "type": "Ksplat[:omission? => String, :separator? => Or[String, Regexp]]"
        }
      ]
    }
  ],
  "links": [

  ]
}

Version data entries

28 entries across 28 versions & 1 rubygems

Version Path
ree_lib-1.0.32 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.31 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.30 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.29 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.28 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.27 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.26 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.24 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.23 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.22 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.21 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.20 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.19 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.18 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.17 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.16 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.15 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.14 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.13 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json
ree_lib-1.0.12 lib/ree_lib/packages/ree_string/schemas/ree_string/functions/truncate.schema.json