From 22e1593af216daa964ecbd8af578abeed62a2d74 Mon Sep 17 00:00:00 2001 From: Anton Date: Fri, 3 Jun 2022 13:36:31 +0300 Subject: [PATCH] docs: mention `$.o()` alias --- README.md | 5 ++++- src/main/js/index.d.ts | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56e78db..5c41823 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # 🦪 zx-extra [zx](https://github.com/google/zx) with some extras +## Requirements +* Node.js >= 16.0.0 + ## Install ```shell # npm @@ -65,7 +68,7 @@ const output = (await $.raw`${cmd} ${msg}`).toString().trim() ``` ### `$.opt` -Returns `$` with the specified preset. +Returns `$` with the specified preset. Aliased for `$.o`. ```js const $$ = $.opt({verbose: false, spawn: customSpawn}) diff --git a/src/main/js/index.d.ts b/src/main/js/index.d.ts index ff8e1e0..86e6200 100644 --- a/src/main/js/index.d.ts +++ b/src/main/js/index.d.ts @@ -17,6 +17,7 @@ interface $ { silent: $ preferLocal?: boolean opt: (options: any) => $ + o: (options: any) => $ } export function createHook(opts?: $, name?: string, cb?: (p: ProcessPromise) => any, configurable?: boolean)