Skip to main content

duplicateNodes()v4.0.530

Duplicates one or more nodes beside their originals.

warning

Draft API: This API is experimental and may change.

duplicate-nodes.ts
import {duplicateNodes, type CodemodProject, type NodeReference} from '@remotion/codemods';

declare const project: CodemodProject;
declare const node: NodeReference;

const result = await duplicateNodes({
  project,
  nodes: [node],
});

console.log(result);

Copies the node's source, including props and children. Imported component implementations remain shared. Overlapping ancestor/descendant selections are unsupported.

Options​

project​

An in-memory CodemodProject. The input project is not mutated.

nodes​

The node references to duplicate. They may belong to different files. All references are resolved against the input project; duplicate references are deduplicated.

Return value​

A promise resolving to an object with the following properties.

changes​

An array of {filePath, previousContents, nextContents} file changes. A null content value indicates a created or deleted file.

nodePathRemappings​

An array of {filePath, oldNodePath, newNodePath} mappings. A null old path indicates an insertion; a null new path indicates removal. Apply these mappings to references from the input project. See node references.

insertedNodes​

References to the roots of the new copies, in source order within each file. Descendant references are included in nodePathRemappings.

Errors​

Throws or rejects when the target cannot be resolved, the requested edit is unsupported, or an option is invalid. Failed edits leave the input project unchanged.

Compatibility​

BrowsersServersEnvironments
Chrome
Firefox
Safari
Node.js
Bun
Serverless Functions

See also​