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

Commit 41e2874

Browse files
author
exoego
committed
Update how to use and support matrix
1 parent d3a791f commit 41e2874

File tree

2 files changed

+55
-37
lines changed

2 files changed

+55
-37
lines changed

‎README.md‎

Lines changed: 44 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,60 @@
11
This is a complete Scala.js facade for Node.js for Scala 2.12 and 2.13.
2-
A fork of https://github.com/scalajs-io/nodejs to sustain the project.
3-
4-
## Build Requirements
5-
6-
* [SBT 1.3.x] (http://www.scala-sbt.org/download.html)
7-
* JDK 8 or JDK 11
82

93
## Features
104

115
The Node.js integration is nearly complete (feature for feature), and should be more than sufficient for most web-based
126
and CLI applications.
137

14-
### Supported Modules
8+
## How to use
159

16-
The following core Node.js modules (v8.7.0) have been implemented:
10+
Add below line to your SBT project.
1711

18-
| Node Module | Description |
19-
|-----------------------|---------------------------------------------------------------------------------|
20-
| assert | Provides a simple set of assertion tests that can be used to test invariants. |
21-
| 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. |
22-
| child_process | The child_process module provides the ability to spawn child processes. |
23-
| cluster | The cluster module allows you to easily create child processes that all share server ports. |
24-
| crypto | The crypto module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.|
25-
| dns | Support for DNS queries. |
26-
| events | Node.js Events Interface |
27-
| fs | File I/O is provided by simple wrappers around standard POSIX functions. |
28-
| http | Node.js HTTP Interface |
29-
| https | Node.js HTTPS Interface |
30-
| net | The net module provides you with an asynchronous network wrapper. |
31-
| os | Provides a few basic operating-system related utility functions. |
32-
| path | This module contains utilities for handling and transforming file paths. |
33-
| querystring | The querystring module provides utilities for parsing and formatting URL query strings. |
34-
| readline | Readline allows reading of a stream on a line-by-line basis. |
35-
| repl | The REPL provides a way to interactively run JavaScript and see the results. |
36-
| stream | A stream is an abstract interface implemented by various objects in Node.js. |
37-
| 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. |
38-
| timers | The timer module exposes a global API for scheduling functions to be called at some future period of time. |
39-
| tty | The tty module provides the tty.ReadStream and tty.WriteStream classes. |
40-
| url | The url module provides utilities for URL resolution and parsing. |
41-
| util | The util module is primarily designed to support the needs of Node.js's internal APIs.|
42-
| vm | The vm module provides APIs for compiling and running code within V8 Virtual Machine contexts.|
43-
| zlib | This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. |
12+
```sbt
13+
libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
14+
```
4415

45-
## How to use
16+
## Support matrix
17+
18+
| | ScalaJS 0.6.28+ | ScalaJS 1.x |
19+
| ---------- | :----------------: | :------------: |
20+
| Scala 2.13 | :heavy_check_mark: | :construction: |
21+
| Scala 2.12 | :heavy_check_mark: | :construction: |
22+
| Scala 2.11 | N/A | N/A |
23+
| Scala 2.10 | N/A | N/A |
4624

47-
**TBD**: Not published yet.
25+
- :heavy_check_mark: Supported
26+
- :construction: Not supported but planned
4827

49-
See https://github.com/exoego/scala-js-nodejs/issues/3
28+
### Supported Modules
29+
30+
The following core Node.js modules (v8.7.0) have been implemented:
5031

32+
| Node Module | Description |
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+
| crypto | The crypto module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions. |
39+
| dns | Support for DNS queries. |
40+
| events | Node.js Events Interface |
41+
| fs | File I/O is provided by simple wrappers around standard POSIX functions. |
42+
| http | Node.js HTTP Interface |
43+
| https | Node.js HTTPS Interface |
44+
| net | The net module provides you with an asynchronous network wrapper. |
45+
| os | Provides a few basic operating-system related utility functions. |
46+
| path | This module contains utilities for handling and transforming file paths. |
47+
| querystring | The querystring module provides utilities for parsing and formatting URL query strings. |
48+
| readline | Readline allows reading of a stream on a line-by-line basis. |
49+
| repl | The REPL provides a way to interactively run JavaScript and see the results. |
50+
| stream | A stream is an abstract interface implemented by various objects in Node.js. |
51+
| 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. |
52+
| timers | The timer module exposes a global API for scheduling functions to be called at some future period of time. |
53+
| tty | The tty module provides the tty.ReadStream and tty.WriteStream classes. |
54+
| url | The url module provides utilities for URL resolution and parsing. |
55+
| util | The util module is primarily designed to support the needs of Node.js's internal APIs. |
56+
| vm | The vm module provides APIs for compiling and running code within V8 Virtual Machine contexts. |
57+
| zlib | This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. |
5158

5259
## Example of code
5360

‎package.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,18 @@
22
"name": "nodejs-sfs",
33
"version": "0.4.2",
44
"private": true,
5+
"scripts": {
6+
"lint-md": "remark .",
7+
"fix-md": "remark . -o"
8+
},
9+
"remarkConfig": {
10+
"plugins": [
11+
"remark-preset-lint-recommended"
12+
]
13+
},
514
"dependencies": {
15+
"remark-cli": "^6.0.1",
16+
"remark-preset-lint-recommended": "^3.0.2",
617
"source-map-support": "^0.4.14"
718
}
819
}

0 commit comments

Comments
 (0)