sdk/lib/foldertree
Ce contenu n’est pas encore disponible dans votre langue.
Functions
Section titled “Functions”addPageToFolderTree()
Section titled “addPageToFolderTree()”function addPageToFolderTree( tree: FolderNode[], folderId: string, newPage: FolderNode): FolderNode[]Defined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:180
Adds a new page to the folder tree.
Parameters
Section titled “Parameters”The root of the folder tree.
folderId
Section titled “folderId”string
The ID of the parent folder.
newPage
Section titled “newPage”The new page to add.
Returns
Section titled “Returns”The updated folder tree
findNodeById()
Section titled “findNodeById()”function findNodeById(tree: FolderNode[], id: string): null | FolderNodeDefined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:160
Finds a node by its ID in the tree.
Parameters
Section titled “Parameters”string
The ID of the node to find.
Returns
Section titled “Returns”null | FolderNode
The node or null if not found.
findNodeByPath()
Section titled “findNodeByPath()”function findNodeByPath(tree: FolderNode[], path: string[]): null | FolderNodeDefined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:47
Finds a node in the tree that matches the given URL path.
Parameters
Section titled “Parameters”The root of the folder tree.
string[]
The URL path to locate.
Returns
Section titled “Returns”null | FolderNode
The matching node or null if not found.
findNodesAlongPath()
Section titled “findNodesAlongPath()”function findNodesAlongPath(tree: FolderNode[], path: string[]): FolderNode[]Defined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:130
Finds all nodes along the path to a given URL.
Parameters
Section titled “Parameters”The root of the folder tree.
string[]
The URL path to locate.
Returns
Section titled “Returns”The nodes along the path.
findNodesAlongPathToId()
Section titled “findNodesAlongPathToId()”function findNodesAlongPathToId(tree: FolderNode[], id: string): FolderNode[]Defined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:68
Finds all nodes along the path to a specific node by its ID.
Parameters
Section titled “Parameters”The root of the folder tree.
string
The ID of the target node.
Returns
Section titled “Returns”An array of nodes along the path or an empty array if the node is not found.
generateFolderTree()
Section titled “generateFolderTree()”function generateFolderTree(folders: { id: string; name: string; parent: null | string; }[]): FolderNode[]Defined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:9
Builds a folder structure from the provided folder data.
Parameters
Section titled “Parameters”folders
Section titled “folders”{
id: string;
name: string;
parent: null | string;
}[]
An array of folder data to build the folder structure from.
Returns
Section titled “Returns”An array of folder nodes representing the folder structure.
getFullPath()
Section titled “getFullPath()”function getFullPath(tree: FolderNode[], path: string[]): string[]Defined in: studiocms/packages/studiocms/src/sdk/lib/foldertree.ts:99
Finds the full path to a node based on its URL.
Parameters
Section titled “Parameters”The root of the folder tree.
string[]
The URL path to locate.
Returns
Section titled “Returns”string[]
The full path as an array of node names.