txtshr-renderer 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A remote renderer loaded by the txtshr viewer.
+ *
+ * The module must export a `render` function matching this interface.
+ * If `render` returns a function, the viewer will call it when the renderer
+ * is torn down (use it to clean up event listeners, timers, etc.).
+ */
+export interface RemoteRenderer {
+    render(el: HTMLElement, text: string): void | (() => void);
+}
+/**
+ * Identity helper that types your renderer object against the RemoteRenderer
+ * interface. Use it to get compile-time type checking without a runtime cost.
+ *
+ * @example
+ * import { defineRenderer } from 'txtshr-renderer';
+ *
+ * export const { render } = defineRenderer({
+ *   render(el, text) {
+ *     el.textContent = text;
+ *   },
+ * });
+ */
+export declare const defineRenderer: (r: RemoteRenderer) => RemoteRenderer;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;CAC5D;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GAAI,GAAG,cAAc,KAAG,cAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,14 @@
+/**
+ * Identity helper that types your renderer object against the RemoteRenderer
+ * interface. Use it to get compile-time type checking without a runtime cost.
+ *
+ * @example
+ * import { defineRenderer } from 'txtshr-renderer';
+ *
+ * export const { render } = defineRenderer({
+ *   render(el, text) {
+ *     el.textContent = text;
+ *   },
+ * });
+ */
+export const defineRenderer = (r) => r;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "txtshr-renderer",
+  "version": "1.0.0",
+  "description": "TypeScript interface for txtshr remote renderers",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "tsc"
+  },
+  "keywords": ["txtshr", "renderer"],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}