https://github.com/ruby/timeout
Timeout provides a way to auto-terminate a potentially long-running operation if it hasn't finished in a fixed amount of time.
https://github.com/ruby/timeout
ruby
Last synced: 7 months ago
JSON representation
Timeout provides a way to auto-terminate a potentially long-running operation if it hasn't finished in a fixed amount of time.
- Host: GitHub
- URL: https://github.com/ruby/timeout
- Owner: ruby
- License: other
- Created: 2019-08-06T03:47:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-30T01:33:35.000Z (8 months ago)
- Last Synced: 2025-05-03T08:37:16.057Z (8 months ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 167 KB
- Stars: 147
- Watchers: 34
- Forks: 25
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Timeout
Timeout provides a way to auto-terminate a potentially long-running
operation if it hasn't finished in a fixed amount of time.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'timeout'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install timeout
## Usage
```ruby
require 'timeout'
status = Timeout.timeout(5) {
# Something that should be interrupted if it takes more than 5 seconds...
}
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/timeout.