interface FolderData {
    _id: string;
    name: string;
    type: string;
    description: string;
    folder: string;
    sorting: string;
    sort: number;
    color: string;
    flags: object;
    _stats: DocumentStats;
}

Properties

_id: string

The _id which uniquely identifies this Folder document

name: string

The name of this Folder

type: string

The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES

description: string

An HTML description of the contents of this folder

folder: string

The _id of a parent Folder which contains this Folder

sorting: string

The sorting mode used to organize documents within this Folder, in ["a", "m"]

sort: number

The numeric sort value which orders this Folder relative to its siblings

color: string

A color string used for the background color of this Folder

flags: object

An object of optional key/value flags

_stats: DocumentStats

An object of creation and access information