@eggjs/onerror 4.0.0-beta.33 → 4.0.0-beta.34

package/README.md

@@ -16,15 +16,9 @@
 
 Default error handling plugin for egg.
 
-## Install
-
-```bash
-npm i @eggjs/onerror
-```
-
 ## Usage
 
-`egg-onerror` is on by default in egg. But you still can configure its properties to fits your scenarios.
+`onerror` plugin is enabled by default in egg. But you still can configure its properties to fits your scenarios.
 
 - `errorPageUrl: String or Function` - If user request html pages in production environment and unexpected error happened, it will redirect user to `errorPageUrl`.
 - `accepts: Function` - detect user's request accept `json` or `html`.
@@ -34,12 +28,16 @@ npm i @eggjs/onerror
 - `json: Function` - customize json error handler.
 - `jsonp: Function` - customize jsonp error handler.
 
-```js
-// config.default.js
-// errorPageUrl support function
-exports.onerror = {
-  errorPageUrl: (err, ctx) => ctx.errorPageUrl || '/500',
-};
+```ts
+// config/config.default.ts
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  onerror: {
+    // errorPageUrl support function
+    errorPageUrl: (err, ctx) => ctx.errorPageUrl || '/500',
+  },
+});
 
 // an accept detect function that mark all request with `x-requested-with=XMLHttpRequest` header accepts json.
 function accepts(ctx) {

package/dist/index.d.ts

@@ -1 +1,18 @@
 import './types.ts';
+import { type EggPluginFactory } from 'egg';
+/**
+ * Onerror plugin
+ *
+ * @since 4.1.0
+ * Usage:
+ * ```ts
+ * // config/plugin.ts
+ * import onerrorPlugin from '@eggjs/onerror';
+ *
+ * export default {
+ *   ...onerrorPlugin(),
+ * };
+ * ```
+ */
+declare const _default: EggPluginFactory;
+export default _default;

package/dist/index.js

@@ -1,2 +1,23 @@
 import "./types.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==
+import { definePluginFactory } from 'egg';
+/**
+ * Onerror plugin
+ *
+ * @since 4.1.0
+ * Usage:
+ * ```ts
+ * // config/plugin.ts
+ * import onerrorPlugin from '@eggjs/onerror';
+ *
+ * export default {
+ *   ...onerrorPlugin(),
+ * };
+ * ```
+ */
+export default definePluginFactory({
+    name: 'onerror',
+    enable: true,
+    path: import.meta.dirname,
+    optionalDependencies: ['jsonp'],
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUM7QUFFcEIsT0FBTyxFQUFFLG1CQUFtQixFQUF5QixNQUFNLEtBQUssQ0FBQztBQUVqRTs7Ozs7Ozs7Ozs7OztHQWFHO0FBQ0gsZUFBZSxtQkFBbUIsQ0FBQztJQUNqQyxJQUFJLEVBQUUsU0FBUztJQUNmLE1BQU0sRUFBRSxJQUFJO0lBQ1osSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTztJQUN6QixvQkFBb0IsRUFBRSxDQUFDLE9BQU8sQ0FBQztDQUNoQyxDQUFxQixDQUFDIn0=

package/package.json

@@ -1,16 +1,10 @@
 {
   "name": "@eggjs/onerror",
-  "version": "4.0.0-beta.33",
+  "version": "4.0.0-beta.34",
   "publishConfig": {
     "access": "public"
   },
   "description": "error handler for egg",
-  "eggPlugin": {
-    "name": "onerror",
-    "optionalDependencies": [
-      "jsonp"
-    ]
-  },
   "homepage": "https://github.com/eggjs/egg/tree/next/plugins/onerror",
   "repository": {
     "type": "git",
@@ -33,16 +27,16 @@
     "stack-trace": "^0.0.10"
   },
   "peerDependencies": {
-    "egg": "4.1.0-beta.33"
+    "egg": "4.1.0-beta.34"
   },
   "devDependencies": {
     "@types/mustache": "^4.2.5",
     "@types/stack-trace": "^0.0.33",
     "tsdown": "0.15.11",
     "typescript": "^5.9.3",
-    "vitest": "4.0.4",
-    "@eggjs/mock": "7.0.0-beta.33",
-    "egg": "4.1.0-beta.33"
+    "vitest": "4.0.5",
+    "@eggjs/mock": "7.0.0-beta.34",
+    "egg": "4.1.0-beta.34"
   },
   "type": "module",
   "exports": {