future

Version, currently 1.0.03 versions

github.com/crystal-community/future.cr

No description declared in shard.yml.

34 stars
0 dependents
License: MIT

Nothing has been indexed for 1.0.0 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

# Add this to your shard.yml
dependencies:
  future:
    github: crystal-community/future.cr
    version: ~> 1.0.0

Then run:

shards install

shard.yml

No shard.yml has been indexed for 1.0.0. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

Documentation

Read the API documentation

Generated from the source of the current release. The first visit to a release that has never been documented starts its build.

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# future

Provides `delay`, `future`, and `lazy` convenient methods to perform operations in a separate Fiber.

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml
   dependencies:
     future:
       github: crystal-community/future.cr
   ```

2. Run `shards install`

## Usage

```crystal
require "future"

d = delay(1) { Process.signal(Signal::KILL, Process.pid) }
# ... long operations ...
d.cancel
```

## Contributing

1. Fork it (<https://github.com/crystal-community/future.cr/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Brian J. Cardiff](https://github.com/bcardiff) - creator and maintainer