@lexical/headless 0.9.0 → 0.9.2

package/LexicalHeadless.dev.js

@@ -9,6 +9,13 @@
 var lexical = require('lexical');
 
 /** @module @lexical/headless */
+/**
+ * Generates a headless editor that allows lexical to be used without the need for a DOM, eg in Node.js.
+ * Throws an error when unsupported metehods are used.
+ * @param editorConfig - The optional lexical editor configuration.
+ * @returns - The configured headless editor.
+ */
+
 function createHeadlessEditor(editorConfig) {
   const editor = lexical.createEditor(editorConfig);
   editor._headless = true;

package/README.md

@@ -1,6 +1,6 @@
 # `@lexical/headless`
 
-This package allows you to use interact with Lexical in a headless environment (one that does not rely on DOM, e.g. for Node.js environment), and use its
+This package allows you to interact with Lexical in a headless environment (one that does not rely on DOM, e.g. for Node.js environment), and use its
 main features like editor.update(), editor.registerNodeTransform(), editor.registerUpdateListener()
 to create, update or traverse state.
 

package/index.d.ts

@@ -7,4 +7,10 @@
  *
  */
 import type { CreateEditorArgs, LexicalEditor } from 'lexical';
+/**
+ * Generates a headless editor that allows lexical to be used without the need for a DOM, eg in Node.js.
+ * Throws an error when unsupported metehods are used.
+ * @param editorConfig - The optional lexical editor configuration.
+ * @returns - The configured headless editor.
+ */
 export declare function createHeadlessEditor(editorConfig?: CreateEditorArgs): LexicalEditor;

package/package.json

@@ -8,10 +8,10 @@
     "headless"
   ],
   "license": "MIT",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "main": "LexicalHeadless.js",
   "peerDependencies": {
-    "lexical": "0.9.0"
+    "lexical": "0.9.2"
   },
   "repository": {
     "type": "git",