docs: update api

midwayjs · May 13, 2024 · 6b27f3a · 6b27f3a
1 parent 08ae72a
commit 6b27f3a
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -25,10 +25,20 @@ $ npx mwtsc --watch --project tsconfig.production.json --run ./bootstrap.js
 
 You can use `mwtsc` API in your code to extend your own logic.
 
+mwtsc API:
+
+* `run` - run tsc compile
+* `chokidar` - watch file change
+
+run API:
+* `exit` - exit process
+* `restart` - restart process
+* `onExit` - on exit event
+
 ```ts
 // custom.js
 const { run, chokidar } = require('mwtsc');
-const { restart, exit, onExit, onRestart } = run();
+const { restart, exit, onExit } = run();
 
 const watcher = chokidar.watch('node_modules/**/*.ts', {
   ignoreInitial: true,
@@ -53,7 +63,7 @@ Rewrite dev command in `package.json` .
 ```json
 {
   "scripts": {
-    "dev": "./custom.js --watch --run ./bootstrap.js"
+    "dev": "NODE_ENV=local node ./custom.js --watch --run ./bootstrap.js"
   }
 }
 ```