Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorskyflyer/npm-simple-exec
๐บ Command. Execution. Made. Simple. โถ
https://github.com/igorskyflyer/npm-simple-exec
back-end bash batch biome command exec execute igorskyflyer javascript linux macos node npm shell terminal unix vitest windows
Last synced: 2 months ago
JSON representation
๐บ Command. Execution. Made. Simple. โถ
- Host: GitHub
- URL: https://github.com/igorskyflyer/npm-simple-exec
- Owner: igorskyflyer
- License: mit
- Created: 2019-10-18T20:01:57.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T18:16:38.000Z (5 months ago)
- Last Synced: 2024-09-30T21:49:47.913Z (3 months ago)
- Topics: back-end, bash, batch, biome, command, exec, execute, igorskyflyer, javascript, linux, macos, node, npm, shell, terminal, unix, vitest, windows
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@igor.dvlpr/simple-exec
- Size: 1.06 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
SimpleExec
๐บCommand. Execution. Made. Simple. โถ
๐ Support further development
I work hard for every project, including this one
and your support means a lot to me!
Consider buying me a coffee. โ
Thank you for supporting my efforts! ๐๐
@igorskyflyer
## ๐ Table of contents
- [Usage](#-usage)
- [API](#-api)
- [Types](#types)
- [ExecResult](#execresult)
- [ExecCallback](#execcallback)
- [Functions](#functions)
- [executeSync()](#executesynccommand-string-execresult)
- [executeCallback()](#executecallbackcommand-string-callback-execcallback-void)
- [execute()](#executecommand-string-promisestring)
- [executeParallel(...commands)](#executeparallelcommands-string-promisestring)
- [executeParallel(commands)](#executeparallelcommands-string-promisestring-1)
- [Examples](#-examples)
- [Changelog](#-changelog)
- [License](#-license)
- [Related](#-related)
- [Author](#-author)
## ๐ต๐ผ Usage
Install it by executing:
```shell
npm i '@igor.dvlpr/simple-exec'
```
## ๐คน๐ผ API
The API exposes two types:
- `ExecResult`
- `ExecCallback`
### Types
#### `ExecResult`
A simple object structured as:
```ts
{
error: string,
output: string
}
```
#### `ExecCallback`
A callback with the method signature of:
```ts
type ExecCallback = (result: ExecResult) => void
```
---
### Functions
#### `executeSync(command: string): ExecResult`
*Synchronously executes the specified command.*
`command` - Command to execute.
Will throw an error if no command is provided.
Returns the `ExecResult` object with standard and error outputs.
```js
import { executeSync } from '@igor.dvlpr/simple-exec'
const result = executeSync('dir /b')
if (result.error) {
console.error(result.error) // log the error
} else {
console.log(result.output) // log the contents of the directory
}
```
---
#### `executeCallback(command: string, callback: ExecCallback): void`
*Asynchronously, with a callback executes the specified command.*
`command` - Command to execute.
`callback` - The function to call after the command is executed.
Will throw an error if no command is provided.
```js
import { executeCallback } from '@igor.dvlpr/simple-exec'
executeCallback('node --version', (result) => {
if (result.error) {
console.error(result.error) // log the error
} else {
console.log(result.output) // log Node version
}
})
```
---
#### `execute(command: string): Promise`
*Asynchronously executes the specified command.*
`command` - Command to execute.
Will throw an error if no command is provided.
Returns the standard output.
```js
import { execute } from '@igor.dvlpr/simple-exec'
try {
const result: string = await execute('npm --version')
console.log(result) // log NPM version
} catch(exp) {
console.error(exp) // log the error
}
```
---
#### `executeParallel(...commands: string[]): Promise;`
*Asynchronously and in parallel executes the specified commands.*
`commands` - Commands to execute, rest string parameters, e.g. `executeParallel('command-one', 'command-two', 'command-three')`.
Will throw an error if any of the commands causes an error.
Returns the standard output of each command.
```js
import { executeParallel } from '@igor.dvlpr/simple-exec'
try {
const results: string[] = await executeParallel('npm --version', 'node --version', 'npm pack')
console.log(results) // log the results which is a string array
} catch(exp) {
console.error(exp) // log the error
}
```
---
#### `executeParallel(commands: string[]): Promise`
*Asynchronously and in parallel executes the specified commands.*
`commands` - Commands to execute, a string array, e.g. `executeParallel(['command-one', 'command-two', 'command-three'])`.
Will throw an error if any of the commands causes an error.
Returns the standard output of each command.
```js
import { executeParallel } from '@igor.dvlpr/simple-exec'
try {
const results: string[] = executeParallel(['npm --version', 'node --version', 'npm pack'])
console.log(results) // log the results which is a string array
} catch(exp) {
console.error(exp) // log the error
}
```
---
## โจ Examples
`example.ts`
```ts
import { executeParallel } from '@igor.dvlpr/simple-exec'
const result: string[] = await executeParallel([
'npm --version',
'node --version',
'npm --version'
]) // will log ['', '', '']
// e.g. [ '10.8.2', 'v22.5.1', '10.8.2' ]
```
---
## ๐ Changelog
๐ The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-simple-exec/blob/main/CHANGELOG.md).
---
## ๐ชช License
Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-simple-exec/blob/main/LICENSE).
---
## ๐งฌ Related
[@igor.dvlpr/mp3size](https://www.npmjs.com/package/@igor.dvlpr/mp3size)
> _๐งฎ Calculates an estimated file size of Mp3 files. ๐ถ_
[@igor.dvlpr/windev](https://www.npmjs.com/package/@igor.dvlpr/windev)
> _๐ Provides ways of checking whether a path is a legacy Windows device. ๐พ_
[@igor.dvlpr/emojilyzer](https://www.npmjs.com/package/@igor.dvlpr/emojilyzer)
> _๐ฌ Emojifies strings, converting textual representations of emojis to graphical ones. ๐๏ธ_
[@igor.dvlpr/astro-post-excerpt](https://www.npmjs.com/package/@igor.dvlpr/astro-post-excerpt)
> _โญ An Astro component that renders post excerpts for your Astro blog - directly from your Markdown and MDX files. Astro v2+ collections are supported as well! ๐_
[@igor.dvlpr/scrollend-polyfill](https://www.npmjs.com/package/@igor.dvlpr/scrollend-polyfill)
> _๐ด A performant and light (< 1.5KB) JavaScript polyfill for the scrollend Event. โธ๏ธ_
---
### ๐จ๐ปโ๐ป Author
Created by **Igor Dimitrijeviฤ** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).