https://github.com/Kotlin/kotlinx-nodejs

Kotlin external declarations for using the Node.js API from Kotlin code targeting JavaScript
https://github.com/Kotlin/kotlinx-nodejs

kotlin kotlin-externals kotlin-js nodejs

Last synced: about 2 months ago
JSON representation

Kotlin external declarations for using the Node.js API from Kotlin code targeting JavaScript

• Host: GitHub
• URL: https://github.com/Kotlin/kotlinx-nodejs
• Owner: Kotlin
• License: apache-2.0
• Created: 2020-04-10T12:58:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-12T12:10:33.000Z (about 2 years ago)
• Last Synced: 2024-07-04T00:57:01.520Z (3 months ago)
• Topics: kotlin, kotlin-externals, kotlin-js, nodejs
• Language: Kotlin
• Homepage: https://kotl.in/js
• Size: 432 KB
• Stars: 214
• Watchers: 26
• Forks: 19
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# kotlinx-nodejs

[![Kotlin Experimental](https://kotl.in/badges/experimental.svg)](https://kotlinlang.org/docs/components-stability.html)

[![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)

`kotlinx-nodejs` provides Kotlin [external declarations](https://kotlinlang.org/docs/reference/js-interop.html) for using the [Node.js API](https://nodejs.org/docs/latest/api/) from Kotlin code targeting JavaScript. 

## We're currently [experimental](https://kotlinlang.org/docs/reference/evolution/components-stability.html)!

**Right now the only thing we guarantee is that the provided source set is compiling.** There can be, unfortunately, 

some inconsistent, missing, redundant, or even unusable declarations.

 

Feel free to submit [issues and bug reports](https://github.com/Kotlin/kotlinx-nodejs/issues) as you encounter them. We will do our best to address them as soon as possible.

Keep in mind that these sources are generated with [Dukat](https://github.com/Kotlin/dukat) and **are not supposed to be edited manually**. Please do not send pull requests to this repository directly. Instead, please file an issue about the improvements you have in mind – we can then adjust the generator tool accordingly.

## Setup

To add `kotlinx-nodejs` to your project, make sure you have jcenter added to your repositories. You can then add a dependency:

```kotlin

repositories {

    // . . .

    jcenter()

}

dependencies {

    // . . .

    implementation("org.jetbrains.kotlinx:kotlinx-nodejs:0.0.7")

}

```