dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 12:19:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(oxc-transform): Modify the example code in the Readme file (#6103)

Browse source
This commit is contained in:
loong.woo 2024-09-27 14:12:30 +08:00 committed by GitHub
parent 933a7431b1
commit 6167f29022
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
npm/oxc-transform/README.md
View file

@ -12,10 +12,10 @@ This is still in alpha and may yield incorrect results, feel free to [submit a b
import assert from 'assert';
import oxc from 'oxc-transform';
const { sourceMap, sourceText, errors } = oxc.isolatedDeclaration('test.ts', 'class A {}', { sourcemap: true });
const { map, code, errors } = oxc.isolatedDeclaration('test.ts', 'class A {}', { sourcemap: true });
assert.equal(sourceText, 'declare class A {}\n');
assert.deepEqual(ret.sourceMap, {
assert.equal(code, 'declare class A {}\n');
assert.deepEqual(map, {
mappings: 'AAAA,cAAM,EAAE,CAAE',
names: [],
sources: ['test.ts'],
@ -30,15 +30,17 @@ assert(errors.length == 0);
export function isolatedDeclaration(
filename: string,
sourceText: string,
options: IsolatedDeclarationsOptions,
options?: IsolatedDeclarationsOptions,
): IsolatedDeclarationsResult;
export interface IsolatedDeclarationsOptions {
sourcemap: boolean;
stripInternal?: boolean;
sourcemap?: boolean;
}
export interface IsolatedDeclarationsResult {
sourceText: string;
code: string;
map?: SourceMap;
errors: Array<string>;
}
```