Function Updated 22 Oct 2026

`getFolderProps(folderPath)`

Get a specified folders current properties.

Parameters

folderPathstringrequired

Absolute path to folder.

Returns

An object with the current properties for the specified folder, or null when the folder has no properties document. Throws error 1 when the path is empty or the folder does not exist (unlike getFolder, which returns null).

Example

Mixed HTML (or any text file) with inline JavaScript between hash signs.

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

The template above produces this output:

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

Normal JavaScript, running in the browser or on the Docly™ server.

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