oxc-transform - npm Package Compare versions

Comparing version 0.15.0 to 0.15.1

package.json

 {
   "name": "oxc-transform",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "Oxc transform Node API",
@@ -26,11 +26,11 @@ "keywords": [
   "optionalDependencies": {
-    "@oxc-transform/binding-win32-x64-msvc": "0.15.0",
-    "@oxc-transform/binding-win32-arm64-msvc": "0.15.0",
-    "@oxc-transform/binding-linux-x64-gnu": "0.15.0",
-    "@oxc-transform/binding-linux-arm64-gnu": "0.15.0",
-    "@oxc-transform/binding-linux-x64-musl": "0.15.0",
-    "@oxc-transform/binding-linux-arm64-musl": "0.15.0",
-    "@oxc-transform/binding-darwin-x64": "0.15.0",
-    "@oxc-transform/binding-darwin-arm64": "0.15.0"
+    "@oxc-transform/binding-win32-x64-msvc": "0.15.1",
+    "@oxc-transform/binding-win32-arm64-msvc": "0.15.1",
+    "@oxc-transform/binding-linux-x64-gnu": "0.15.1",
+    "@oxc-transform/binding-linux-arm64-gnu": "0.15.1",
+    "@oxc-transform/binding-linux-x64-musl": "0.15.1",
+    "@oxc-transform/binding-linux-arm64-musl": "0.15.1",
+    "@oxc-transform/binding-darwin-x64": "0.15.1",
+    "@oxc-transform/binding-darwin-arm64": "0.15.1"
   }
 }

README.md

@@ -1,17 +0,30 @@
-# The JavaScript Oxidation Compiler
+# Oxc Transform
 
-See index.d.ts for `parseSync` and `parseAsync` API.
+## [Isolated Declarations for Standalone DTS Emit](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/#isolated-declarations)
 
-## ESM
+Based on Oxc and conforms to TypeScript Compiler's `--isolated-declaration` `.d.ts` emit.
 
+This is still in alpha and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md&title=isolated-declarations:).
+
+### Usage
+
 ```javascript
-import oxc from './index.js';
 import assert from 'assert';
+import oxc from 'oxc-transform';
 
-test(oxc.isolatedDeclaration("test.ts", "class A {}"), "declare class A {}\n");
+const { sourceText, errors } = oxc.isolatedDeclaration("test.ts", "class A {}");
 
-function test(ret, expected) {
-  assert.equal(ret.sourceText, expected);
-  assert(ret.errors.length == 0);
+assert.equal(sourceText, "declare class A {}\n");
+assert(errors.length == 0);
+```
+
+### API
+
+```typescript
+export function isolatedDeclaration(filename: string, sourceText: string): IsolatedDeclarationsResult
+
+export interface IsolatedDeclarationsResult {
+  sourceText: string
+  errors: Array<string>
 }
 ```

No alert changes

Improved metrics

Total package byte prevSize

11750

increased by5.31%

Number of lines in readme file

31

increased by72.22%

No dependency changes