docs: mention $.o() alias

qiwi · Jun 3, 2022 · 22e1593 · 22e1593
1 parent 9e8a4f4
commit 22e1593
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git 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
@@ -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)