Contents

---
title: List
layout: gem-single
name: dry-monads
---

### `bind`

Lifts a block/proc and runs it against each member of the list. The block must return a value coercible to a list. As in other monads if no block given the first argument will be treated as callable and used instead.

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[1, 2].bind { |x| [x + 1] } # => List[2, 3]
M::List[1, 2].bind(-> x { [x, x + 1] }) # => List[1, 2, 2, 3]

M::List[1, nil].bind { |x| [x + 1] } # => error
```

### `fmap`

Maps a block over the list. Acts as `Array#map`. As in other monads, if no block given the first argument will be treated as callable and used instead.

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[1, 2].fmap { |x| x + 1 } # => List[2, 3]
```

### `value`

You always can unwrap the result by calling `value`.

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[1, 2].value # => [1, 2]
```

### Concatenation

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[1, 2] + M::List[3, 4] # => List[1, 2, 3, 4]
```

### `head` and `tail`

`head` returns the first element wrapped with a `Maybe`.

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[1, 2, 3, 4].head # => Some(1)
M::List[1, 2, 3, 4].tail # => List[2, 3, 4]
```

### `traverse`

Traverses the list with a block (or without it). This method "flips" List structure with the given monad (obtained from the type).

**Note that traversing requires the list to be typed.**

```ruby
require 'dry/monads/list'

M = Dry::Monads

M::List[M::Success(1), M::Success(2)].typed(M::Result).traverse # => Success([1, 2])
M::List[M::Maybe(1), M::Maybe(nil), M::Maybe(3)].typed(M::Maybe).traverse # => None

# also, you can use fmap with #traverse

M::List[1, 2].fmap { |x| M::Success(x) }.typed(M::Result).traverse # => Success([1, 2])
M::List[1, nil, 3].fmap { |x| M::Maybe(x) }.typed(M::Maybe).traverse # => None
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
dry-monads-1.3.5	docsite/source/list.html.md
dry-monads-1.3.4	docsite/source/list.html.md
dry-monads-1.3.3	docsite/source/list.html.md
dry-monads-1.3.2	docsite/source/list.html.md