Skip to content
This repository was archived by the owner on Jul 30, 2024. It is now read-only.

Commit 5118809

Browse files
author
TATSUNO Yasuhiro
authored
Merge pull request #45 from exoego/readme
Update README to include links to node modules
2 parents 690a2c6 + 51dea02 commit 5118809

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

‎README.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
This is a complete Scala.js facade for Node.js for Scala 2.12 and 2.13.
1+
# scala-js-nodejs
22

3-
## Features
4-
5-
The Node.js integration is nearly complete (feature for feature), and should be more than sufficient for most web-based
6-
and CLI applications.
7-
8-
## How to use
9-
10-
Add below line to your SBT project.
11-
12-
```sbt
13-
libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
14-
```
3+
Scala.js type facades for Node.js v8 and later.
154

165
## Support matrix
176

@@ -25,37 +14,48 @@ libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
2514
- :heavy_check_mark: Supported
2615
- :construction: Not supported but planned
2716

28-
### Supported Modules
17+
## Supported Modules
2918

3019
The following core Node.js modules (v8.7.0+) have been implemented:
3120

32-
| Node Module | Description | v10 & v12 support |
33-
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
34-
| assert | Provides a simple set of assertion tests that can be used to test invariants. | |
35-
| buffer | The Buffer class was introduced as part of the Node.js API to make it possible to interact with octet streams in the context of things like TCP streams and file system operations. | |
36-
| child_process | The child_process module provides the ability to spawn child processes. | |
37-
| cluster | The cluster module allows you to easily create child processes that all share server ports. | |
38-
| console | The `console` module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers. | :heavy_check_mark: |
39-
| crypto | The crypto module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions. | |
40-
| dns | Support for DNS queries. | |
41-
| events | Node.js Events Interface | |
42-
| fs | File I/O is provided by simple wrappers around standard POSIX functions. | |
43-
| http | Node.js HTTP Interface | |
44-
| https | Node.js HTTPS Interface | |
45-
| net | The net module provides you with an asynchronous network wrapper. | |
46-
| os | Provides a few basic operating-system related utility functions. | |
47-
| path | This module contains utilities for handling and transforming file paths. | |
48-
| querystring | The querystring module provides utilities for parsing and formatting URL query strings. | |
49-
| readline | Readline allows reading of a stream on a line-by-line basis. | |
50-
| repl | The REPL provides a way to interactively run JavaScript and see the results. | |
51-
| stream | A stream is an abstract interface implemented by various objects in Node.js. | |
52-
| string-decoder | The string_decoder module provides an API for decoding Buffer objects into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 characters. | |
53-
| timers | The timer module exposes a global API for scheduling functions to be called at some future period of time. | |
54-
| tty | The tty module provides the tty.ReadStream and tty.WriteStream classes. | |
55-
| url | The url module provides utilities for URL resolution and parsing. | |
56-
| util | The util module is primarily designed to support the needs of Node.js's internal APIs. | |
57-
| vm | The vm module provides APIs for compiling and running code within V8 Virtual Machine contexts. | |
58-
| zlib | This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. | |
21+
| Node Module | v10 & v12 support |
22+
| ------------------------------------------------------------ | ------------------ |
23+
| [assert](https://nodejs.org/api/assert.html) | |
24+
| [buffer](https://nodejs.org/api/buffer.html) | :heavy_check_mark: |
25+
| [child_process](https://nodejs.org/api/child_process.html) | |
26+
| [cluster](https://nodejs.org/api/cluster.html) | |
27+
| [console](https://nodejs.org/api/console.html) | :heavy_check_mark: |
28+
| [crypto](https://nodejs.org/api/crypto.html) | |
29+
| [dgram](https://nodejs.org/api/dgram.html) | |
30+
| [dns](https://nodejs.org/api/dns.html) | |
31+
| [events](https://nodejs.org/api/events.html) | |
32+
| [fs](https://nodejs.org/api/fs.html) | |
33+
| [http](https://nodejs.org/api/http.html) | |
34+
| [http2](https://nodejs.org/api/http2.html) | |
35+
| [https](https://nodejs.org/api/https.html) | |
36+
| [net](https://nodejs.org/api/net.html) | |
37+
| [os](https://nodejs.org/api/os.html) | |
38+
| [path](https://nodejs.org/api/path.html) | |
39+
| [process](https://nodejs.org/api/process.html) | |
40+
| [querystring](https://nodejs.org/api/querystring.html) | |
41+
| [readline](https://nodejs.org/api/readline.html) | |
42+
| [repl](https://nodejs.org/api/repl.html) | |
43+
| [stream](https://nodejs.org/api/stream.html) | |
44+
| [string-decoder](https://nodejs.org/api/string_decoder.html) | |
45+
| [timers](https://nodejs.org/api/timers.html) | |
46+
| [tty](https://nodejs.org/api/tty.html) | |
47+
| [url](https://nodejs.org/api/url.html) | |
48+
| [util](https://nodejs.org/api/util.html) | |
49+
| [vm](https://nodejs.org/api/vm.html) | |
50+
| [zlib](https://nodejs.org/api/zlib.html) | |
51+
52+
## How to use
53+
54+
Add below line to your SBT project.
55+
56+
```sbt
57+
libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
58+
```
5959

6060
## Example of code
6161

0 commit comments

Comments
 (0)