@midwayjs/view 2.13.0 → 2.13.1

package/index.d.ts

@@ -0,0 +1,47 @@
+export * from './dist/index';
+
+interface RenderOptions {
+  name?: string;
+  root?: string;
+  locals?: Record<string, any>;
+  viewEngine?: string;
+}
+
+declare module '@midwayjs/core/dist/interface' {
+  interface Context {
+    /**
+     * Render a file by view engine, then set to body
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    render(name: string, locals?: any, options?: RenderOptions): Promise<null>;
+
+    /**
+     * Render a file by view engine and return it
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    renderView(
+      name: string,
+      locals?: any,
+      options?: RenderOptions
+    ): Promise<string>;
+
+    /**
+     * Render a template string by view engine
+     * @param {String} tpl - template string
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    renderString(
+      name: string,
+      locals?: any,
+      options?: RenderOptions
+    ): Promise<string>;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/view",
-  "version": "2.13.0",
+  "version": "2.13.1",
   "description": "Midway Component for egg-view",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -20,7 +20,8 @@
   "author": "",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">= 12.13.0"