Skip to content

docs: Change the edition of JVMS from 21 to 25. #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sciencesakura merged 1 commit into from
Jul 25, 2026
Merged

docs: Change the edition of JVMS from 21 to 25. #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/publish-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- '!packages/**/*.test.*'
- 'README.md'
- 'tsconfig.json'
- 'typedoc.json'

jobs:
publish-api-docs:
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Modified UTF-8 is a variant of UTF-8 encoding used internally by the Java platfo
- **Null character**: The null character U+0000 is encoded as a 2-byte sequence 0xC0 0x80 instead of the single byte 0x00.
- **Supplementary characters**: Characters whose code points are above U+FFFF are encoded as two 3-byte sequences instead of a single 4-byte sequence.

See [The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7](https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7) for more details.
See [The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7](https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7) for more details.

## Installation

Expand All @@ -33,7 +33,7 @@ npm install mutf-8-stream

## Usage

The APIs are compatible with the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) standard, providing a simple interface for encoding and decoding Modified UTF-8.
The APIs are compatible with the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/), providing a simple interface for encoding and decoding Modified UTF-8.

### Basic Encoding and Decoding

Expand Down
4 changes: 2 additions & 2 deletions packages/mutf-8-stream/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { type AllowSharedBufferSource, MUtf8Decoder, MUtf8Encoder, type TextDeco
* ```
*
* @see {@link https://encoding.spec.whatwg.org/#interface-textdecoderstream | WHATWG Encoding Standard, TextDecoderStream}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7}
* @since v1.2.0
*/
export class MUtf8DecoderStream extends TransformStream<AllowSharedBufferSource, string> {
Expand Down Expand Up @@ -99,7 +99,7 @@ export class MUtf8DecoderStream extends TransformStream<AllowSharedBufferSource,
* ```
*
* @see {@link https://encoding.spec.whatwg.org/#interface-textencoderstream | WHATWG Encoding Standard, TextEncoderStream}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7}
* @since v1.2.0
*/
export class MUtf8EncoderStream extends TransformStream<string, Uint8Array> {
Expand Down
4 changes: 2 additions & 2 deletions packages/mutf-8/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export type AllowSharedBufferSource = ArrayBuffer | SharedArrayBuffer | ArrayBuf
* ```
*
* @see {@link https://encoding.spec.whatwg.org/#interface-textdecoder | WHATWG Encoding Standard, TextDecoder}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7}
*/
export class MUtf8Decoder {
readonly #fatal: boolean;
Expand Down Expand Up @@ -311,7 +311,7 @@ export class MUtf8Decoder {
* ```
*
* @see {@link https://encoding.spec.whatwg.org/#interface-textencoder | WHATWG Encoding Standard, TextEncoder}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7}
* @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7}
*/
export class MUtf8Encoder {
/**
Expand Down
1 change: 1 addition & 0 deletions typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPointStrategy": "packages",
"entryPoints": ["packages/*"],
"packageOptions": {
Expand Down