README.md

layout	title	permalink
quickstart-core	Core	/core/

[](https://maven-badges.herokuapp.com/maven-central/io.arrow-kt/arrow-core) [](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/) [](https://kotlinlang.org/docs/reference/whatsnew14.html) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://stackoverflow.com/questions/tagged/arrow-kt) [](https://twitter.com/arrow_kt)

Arrow Core. Functional companion to Kotlin’s Standard Library

Arrow Core includes types such as [Either]({{ '/apidocs/arrow-core/arrow.core/-either/' | relative_url }}), [Validated]({{ '/apidocs/arrow-core/arrow.core/-validated/' | relative_url }}) and many extensions to [Iterable]({{ '/apidocs/arrow-core/arrow.core/index.html#functions' | relative_url }}) that can be used when implementing [error handling patterns]({{ '/patterns/error_handling/' | relative_url }}).

Core also includes the base continuation effects system, which includes patterns to remove callbacks and enables controlled effects in direct syntax. Some applications of the effect system reduce boilerplate and enable direct syntax including [monad comprehensions and computation expressions]( {{ '/patterns/monad_comprehensions/' | relative_url }}).

## Arrow Core Overview

#### Quick Start - [Gradle Setup]({{ '/core/#Gradle-kotlin' | relative_url }}) - [Maven Setup]({{ '/core/#Maven' | relative_url }})

Effects & Continuations

• [Effect]({{ '/apidocs/arrow-core/arrow.core.continuations/-effect/' | relative_url }})
• [EffectScope]({{ '/apidocs/arrow-core/arrow.core.continuations/-effect-scope/' | relative_url }})
• [EagerEffect]({{ '/apidocs/arrow-core/arrow.core.continuations/-eager-effect/' | relative_url }})
• [EagerEffectScope]({{ '/apidocs/arrow-core/arrow.core.continuations/-eager-effect-scope/' | relative_url }})

#### Extensions and data types - [Either]({{ '/apidocs/arrow-core/arrow.core/-either/' | relative_url }}) - [Validated]({{ '/apidocs/arrow-core/arrow.core/-validated/' | relative_url }}) - [Option]({{ '/apidocs/arrow-core/arrow.core/-option/' | relative_url }}) - [NonEmptyList]({{ '/apidocs/arrow-core/arrow.core/-non-empty-list/' | relative_url }}) - [Ior]({{ '/apidocs/arrow-core/arrow.core/-ior/' | relative_url }}) - [Eval]({{ '/apidocs/arrow-core/arrow.core/-eval/' | relative_url }}) - [Monoid]({{ '/arrow/typeclasses/monoid/' | relative_url }}) - [Semiring]({{ '/apidocs/arrow-core/arrow.typeclasses/-semiring/' | relative_url }}) - [Extensions]({{ '/apidocs/arrow-core/arrow.core/index.html#functions' | relative_url }})

#### Tutorials - [Error Handling]({{ '/patterns/error_handling/' | relative_url }}) - [Monads]({{ '/patterns/monads/' | relative_url }}) - [Monad Comprehensions]({{ '/patterns/monad_comprehensions/' | relative_url }}) - [Coroutines & Computation blocks]({{ '/fx/coroutines/' | relative_url }})

#### Additional information - [Kotlin's Std Lib Guide](https://kotlinlang.org/api/latest/jvm/stdlib/) - [Pure & Referentially Transparent Functions]({{ '/fx/purity-and-referentially-transparent-functions/' | relative_url }}) - [Why suspend over IO monad]({{ '/effects/io/' | relative_url }}) - [Semantics of Structured Concurrency and Effect]({{ '/arrow/core/continuations/' | relative_url }})

## Setup

{: .setup-subtitle} Configure Arrow for your project

![Jdk]({{ "/img/quickstart/jdk-logo.svg" | relative_url }} "jdk")

Make sure to have the latest version of JDK 1.8 installed.

![Android]({{ "/img/quickstart/android-logo.svg" | relative_url }} "android")

Arrow supports Android starting on API 21 and up.

Gradle Kotlin DSL Gradle Groovy DSL Maven

Basic Setup

In your project's root build.gradle.kts, append this repository to your list:

allprojects {
    repositories {
        mavenCentral()
    }
}

Add the dependencies into the project's build.gradle.kts:

dependencies {
    implementation("io.arrow-kt:arrow-core:1.1.2")
}

BOM file

To avoid specifying the Arrow version for every dependency, a BOM file is available:

dependencies {
    implementation(platform("io.arrow-kt:arrow-stack:1.1.2"))

    implementation("io.arrow-kt:arrow-core")
    ...
}

Next development version

If you want to try the latest features, replace 1.1.2 with on of the latest alpha, beta or rc publications.

Basic Setup

In your project's root build.gradle, append this repository to your list:

allprojects {
    repositories {
        mavenCentral()
    }
}

Add the dependencies into the project's build.gradle:

Arrow Core

def arrow_version = "1.1.2"
dependencies {
    implementation "io.arrow-kt:arrow-core:$arrow_version"
}

BOM file

To avoid specifying the Arrow version for every dependency, a BOM file is available:

def arrow_version = "1.1.2"
dependencies {
    implementation platform("io.arrow-kt:arrow-stack:$arrow_version")

    implementation "io.arrow-kt:arrow-core"
    ...
}

Next development version

If you want to try the latest features, replace 1.1.2 with one of the latest alpha, beta or rc publications.

Basic Setup

Make sure to have at least the latest version of JDK 1.8 installed. Add to your pom.xml file the following properties:

<properties>
    <kotlin.version>1.6.10</kotlin.version>
    <arrow.version>1.1.2</arrow.version>
</properties>

Add the dependencies that you want to use:

<dependency>
    <groupId>io.arrow-kt</groupId>
    <artifactId>arrow-core</artifactId>
    <version>${arrow.version}</version>
</dependency>

BOM file

To avoid specifying the Arrow version for every dependency, a BOM file is available:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.arrow-kt</groupId>
            <artifactId>arrow-stack</artifactId>
            <version>${arrow.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement><dependencies>
...
</dependencies>

Next development version

If you want to try the latest features, replace 1.1.2 with one of the latest alpha, beta or rc publications.