Typescript: PropsMerge type is invalid.

slate/packages/slate/src/interfaces/transforms/node.ts

Lines 85 to 96 in c8236ee

    
           setNodes: <T extends Node>( 
        
             editor: Editor, 
        
             props: Partial<T>, 
        
             options?: { 
        
               at?: Location 
        
               match?: NodeMatch<T> 
        
               mode?: MaximizeMode 
        
               hanging?: boolean 
        
               split?: boolean 
        
               voids?: boolean 
        
               compare?: PropsCompare 
        
               merge?: PropsMerge

If we have only one key in props then real type is merge?: (prop: T["key"], node: T["key"]) => T["key"]

Example:

Transforms.setNodes(
                  editor,
                  {
                    key: { value: 1 },
                  },
                  {
                    at: ReactEditor.findPath(editor, leaf),
                    merge(prop: Leaf["key"], node: Leaf["key"]): Leaf["key"] {
                      assert(node.value === 1);
                      return node;
                    },
                  }
                );

Example2:

Transforms.setNodes(
                  editor,
                  {
                    key: "value",
                  },
                  {
                    at: ReactEditor.findPath(editor, leaf),
                    merge(prop: Leaf["key"], node: Leaf["key"]): Leaf["key"] {
                      assert(node === "value");
                      return node;
                    },
                  }
                );

merge function has type PropsMerge which is defines as:

type PropsMerge = (prop: Partial<Node>, node: Partial<Node>) => object

As we see it expects objects but in setNodes usage of merge doesn't match the type as we pass values key by key:
packages\slate\src\transforms-node\set-nodes.ts

          if (merge) {
            if (props[<keyof Node>k] != null)
              newProperties[<keyof Node>k] = merge(
                node[<keyof Node>k],
                props[<keyof Node>k]
              )
          }

Thus i guess PropsMerge type should expect key and appropriate values of descendant, similar to this:

type PropsMerge = <TValue extends Descendant[keyof Descendant]>(key: keyof Descendant, prop: TValue, node: TValue) => TValue

I have no idea how to implement this to get it working with typescript inferring

Fix `PropsMerge` type so `setNodes` `merge` can return scalars

Fix `PropsMerge` type so `setNodes` `merge` can return scalars (#6137)

Fixed by #6137: the merge option's type now accepts and returns any value, so the scalars setNodes passes type-check.

Navigation Menu

Repository navigation

Typescript: PropsMerge type is invalid. #5490

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	setNodes: <T extends Node>(
	editor: Editor,
	props: Partial<T>,
	options?: {
	at?: Location
	match?: NodeMatch<T>
	mode?: MaximizeMode
	hanging?: boolean
	split?: boolean
	voids?: boolean
	compare?: PropsCompare
	merge?: PropsMerge

Typescript: PropsMerge type is invalid. #5490

Description

Activity

skorenb commented on Aug 21, 2024

dylans commented on Oct 10, 2026

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions