https://github.com/robstoll/niok

Kotlin idiomatic API for java.nio.file
https://github.com/robstoll/niok

fileio kotlin nio2

Last synced: 2 months ago
JSON representation

Kotlin idiomatic API for java.nio.file

• Host: GitHub
• URL: https://github.com/robstoll/niok
• Owner: robstoll
• License: apache-2.0
• Created: 2018-09-18T06:02:09.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T06:12:31.000Z (8 months ago)
• Last Synced: 2024-05-02T01:35:38.993Z (8 months ago)
• Topics: fileio, kotlin, nio2
• Language: Kotlin
• Size: 1.57 MB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Download](https://img.shields.io/badge/Download-1.5.0-%23007ec6)](https://search.maven.org/artifact/ch.tutteli.niok/niok/1.5.0/jar)

[![Apache license](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache2.0)

[![Build Status Ubuntu](https://github.com/robstoll/niok/workflows/Ubuntu/badge.svg?event=push)](https://github.com/robstoll/niok/actions?query=workflow%3AUbuntu+branch%3Amain)

[![Build Status Windows](https://github.com/robstoll/niok/workflows/Windows/badge.svg?event=push)](https://github.com/robstoll/niok/actions?query=workflow%3AWindows+branch%3Amain)

[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=robstoll_niok&metric=alert_status)](https://sonarcloud.io/dashboard?id=robstoll_niok)

# Niok - java.nio.file for Kotlin

Niok provides a Kotlin idiomatic API for java.nio.file (the package for non-blocking I/O file operations).

We believe that using `Files` decreases readability => extension functions to the rescue :smirk: 

Next to providing delegations to `Files` it also delegates to Kotlin's built-in extension functions for `File` and

provides additional functions.

# Installation

Niok is published to maven central. Following an example how to use it

```

repositories { mavenCentral() }

dependencies {

    implementation("ch.tutteli.niok:niok:1.5.0")

}

```

# Documentation

Visit [https://robstoll.github.io/niok/kdoc](https://robstoll.github.io/niok/kdoc/).

# Contribute

You found a bug, a delegation to `Files` is missing or there is something else you would like to improve?

Please [open an issue](https://github.com/robstoll/niok/issues/new), contributions are more than welcome :+1:

# License

Niok is licensed under [Apache 2.0](http://opensource.org/licenses/Apache2.0).