Skip to content

Commit fec9da9

Browse files
committed
docs: ✏️ update docs
1 parent 0194e3e commit fec9da9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,13 @@ Executes a shell command with specified arguments and options.
7272
```typescript
7373
import { execute } from '@hyperse/exec-program';
7474

75+
/**
76+
* Execute a file with arguments and options
77+
* @param file - The program/script to execute, as a string or file URL
78+
* @param args - Arguments to pass to `file` on execution.
79+
* @param options - Options to pass to `execa`
80+
* @returns A `ResultPromise` that is both:
81+
*/
7582
declare function execute<T extends ExecOptions>(
7683
file: string,
7784
args?: readonly string[],

0 commit comments

Comments
 (0)