Skip to content

Commit 3c9cc1f

Browse files
committed
fix: export runscript function
1 parent 651b248 commit 3c9cc1f

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ npm install runscript
2626

2727
## Quick start
2828

29+
Commonjs
30+
2931
```js
3032
const { runScript } = require('runscript');
3133

@@ -38,6 +40,20 @@ runScript('node -v', { stdio: 'pipe' })
3840
});
3941
```
4042

43+
ESM & TypeScript
44+
45+
```js
46+
import { runScript } from 'runscript';
47+
48+
runScript('node -v', { stdio: 'pipe' })
49+
.then(stdio => {
50+
console.log(stdio);
51+
})
52+
.catch(err => {
53+
console.error(err);
54+
});
55+
```
56+
4157
### run with timeout
4258

4359
Run user script for a maximum of 10 seconds.
@@ -54,6 +70,16 @@ runScript('node user-script.js', { stdio: 'pipe' }, { timeout: 10000 })
5470
});
5571
```
5672

73+
## Upgrade from 1.x to 2.x
74+
75+
```js
76+
// 1.x
77+
// const runscript = require('runscript');
78+
79+
// 2.x
80+
const { runscript } = require('runscript');
81+
```
82+
5783
## License
5884

5985
[MIT](LICENSE.txt)

src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,5 @@ export function runScript(script: string, options: Options = {}, extraOptions: E
202202
}
203203
});
204204
}
205+
206+
export const runscript = runScript;

test/runscript.test.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
import fs from 'node:fs';
22
import { strict as assert } from 'node:assert';
3-
import { runScript, RunScriptTimeoutError } from '../src/index.js';
3+
import { runscript, runScript, RunScriptTimeoutError } from '../src/index.js';
44
import { getFixtures } from './helper.js';
55

66
describe('test/runscript.test.ts', () => {
77
it('should run `$ node -v`', () => {
88
return runScript('node -v');
99
});
1010

11+
it('should support alias runscript function', () => {
12+
return runscript('node -v');
13+
});
14+
1115
it('should run `$ npm -v`', () => {
1216
return runScript('npm -v');
1317
});

0 commit comments

Comments
 (0)