Documentation
    Preparing search index...

    Type Alias Folder

    A folder in the filesystem.

    type Folder = {
        assetCount: number;
        content?: OffsetBasedPaginationResponse<
            FileSystemEntity<Asset | Folder.Folder>,
        >;
        contentSummary: {
            assetCount: number;
            coverImages: FolderCoverImage[];
            folderCount: number;
        };
        createdAt: Date;
        description: string;
        id: FolderId;
        isNestingLevelReached: boolean;
        modifiedAt: Date;
        name: string;
        nestingLevel: number;
        parentId?: FolderId;
        path: FolderPathEntry[];
    }
    Index

    Properties

    assetCount content? contentSummary createdAt description id isNestingLevelReached modifiedAt name nestingLevel parentId? path

    Properties

    assetCount: number

    Count of all assets in this folder, taking into account all subfolders

    Optionalcontent

    content?: OffsetBasedPaginationResponse<FileSystemEntity<Asset | Folder.Folder>>

    Folder content as a paginated filesystem result.

    contentSummary: {
        assetCount: number;
        coverImages: FolderCoverImage[];
        folderCount: number;
    }

    Summary of the folders content without the need to look into content and tally results.

    Type declaration

    • assetCount: number

      Count of all assets in this folder, not taking into account all subfolders

    • coverImages: FolderCoverImage[]

      The cover images of assets in this folder.

    • folderCount: number

      Count of all folders in this folder, not taking into account all subfolders

    createdAt: Date
    description: string
    id: FolderId
    isNestingLevelReached: boolean

    Whether the current position in the nesting level of this folder has reached the maximum allowed nesting level.

    modifiedAt: Date
    name: string
    nestingLevel: number

    Nesting level of the folder in the filesystem. Zero based.

    A nesting level of 0 means that this is the root folder of the project. A project can have only one root folder.

    parentId?: FolderId

    Id of the parent folder of this folder. Can be undefined if this is the root folder of a project.

    path: FolderPathEntry[]

    Upstream path to the current folder in the filesystem. Useful for breadcrumbs.

    Settings

    Member Visibility

    On This Page

    Properties