diff --git a/CHANGELOG.md b/CHANGELOG.md index a75b57e..518190f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.0.4] - 2024-11-02 + +### Added + +- Added `"type": "module"` to `package.json` to define the package as ESM-only. +- Added `"exports"` field to `package.json` to specify the entry point explicitly for ESM compatibility. + +### Changed + +- Updated `clean` script to `rm -rf ./dist docs` for consistency in paths. + ## [0.0.3] - 2024-10-26 ### Added diff --git a/README.md b/README.md index 8bf782a..b1abb14 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ console.log(views.data.buffer.byteLength); // 4104 ## API +For detailed API documentation, please refer to the [GitHub Pages](https://ain1084.github.io/array-buffer-partitioner/) documentation. + ### `createArrayBufferViews(BufferType: { new(size: number): ArrayBuffer | SharedArrayBuffer }, config: Record)` Creates multiple `TypedArray` views on a single `ArrayBuffer` or `SharedArrayBuffer`. diff --git a/package-lock.json b/package-lock.json index 150d7e6..bb7aa4e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,18 +1,18 @@ { "name": "@ain1084/array-buffer-partitioner", - "version": "0.0.2", + "version": "0.0.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@ain1084/array-buffer-partitioner", - "version": "0.0.2", + "version": "0.0.4", "license": "(MIT OR Apache-2.0)", "devDependencies": { "@types/jest": "^29.5.14", "jest": "^29.0.0", "ts-jest": "^29.2.5", - "typedoc": "^0.26.10", + "typedoc": "^0.26.11", "typescript": "^5.6.3" } }, @@ -4129,9 +4129,9 @@ } }, "node_modules/typedoc": { - "version": "0.26.10", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.10.tgz", - "integrity": "sha512-xLmVKJ8S21t+JeuQLNueebEuTVphx6IrP06CdV7+0WVflUSW3SPmR+h1fnWVdAR/FQePEgsSWCUHXqKKjzuUAw==", + "version": "0.26.11", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.11.tgz", + "integrity": "sha512-sFEgRRtrcDl2FxVP58Ze++ZK2UQAEvtvvH8rRlig1Ja3o7dDaMHmaBfvJmdGnNEFaLTpQsN8dpvZaTqJSu/Ugw==", "dev": true, "license": "Apache-2.0", "dependencies": { diff --git a/package.json b/package.json index 4b7620f..263fbff 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,15 @@ { "name": "@ain1084/array-buffer-partitioner", - "version": "0.0.3", + "version": "0.0.4", "description": "Partition an ArrayBuffer into multiple TypedArray views efficiently.", - "module": "dist/index.js", - "types": "dist/index.d.ts", + "type": "module", + "exports": { + ".": "./dist/index.js" + }, + "types": "./dist/index.d.ts", "scripts": { "build": "tsc", - "clean": "rm -rf dist docs", + "clean": "rm -rf ./dist docs", "prepublishOnly": "npm run clean && npm run build", "test": "jest", "test:watch": "jest --watch", @@ -41,7 +44,7 @@ "@types/jest": "^29.5.14", "jest": "^29.0.0", "ts-jest": "^29.2.5", - "typedoc": "^0.26.10", + "typedoc": "^0.26.11", "typescript": "^5.6.3" } }