getFolderProps(folderPath) Last updated: 28. Oct 2025

Get a specified folders current properties.

Parameters

Name	Type	Description
folderPath	string	Absolute path to folder.

Returns

An object with the current properties for the specified folder.

Example

Code example (#JS)

#JS is mixed HTML (or other text file) with inline JavaScript with # starting and ending each inline statement.

#{
    let props = docly.getFolderProps("Test files");
    write(JSON.stringify(props));
}#

Output

The #JS code above produces the output shown below:

{"DisplayName":"","Description":"","Hide":true,"Image":"","SortOrder":5,"DefaultContent":true,"Accept":"","SpecifyCustomColumns":false,"CustomColumns":[],"CustomColumns_type":"CustomColumns","OKCount":"0","PassedCount":"0","FailedCount":"0","TotalCount":"0","RemainCount":"0"}

Code example (JS)

JS is normal JavaScript either running in the browser or on the Docly™ server.

(folderPath) => {
    // API example
    let props = docly.getFolderProps(folderPath);
    return props;
}