Interface WHFSFolder
interface WHFSFolder {
dbrecord: FsObjectRow;
get created(): Instant;
get description(): string;
get id(): number;
get indexDoc(): null | number;
get isFile(): false;
get isFolder(): true;
get isPinned(): boolean;
get isUnlisted(): boolean;
get link(): null | string;
get modified(): Instant;
get name(): string;
get ordering(): number;
get parent(): null | number;
get parentSite(): null | number;
get sitePath(): null | string;
get title(): string;
get type(): string;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
createFile(name: string, metadata?: CreateFileMetadata): Promise<WHFSFile>;
createFolder(
name: string,
metadata?: CreateFolderMetadata,
): Promise<WHFSFolder>;
delete(): Promise<void>;
describeType(): Promise<FolderTypeInfo>;
ensureFile(
name: string,
requiredmetadata?: UpdateFileMetadata,
options?: { ifNew: UpdateFileMetadata },
): Promise<WHFSFile>;
ensureFolder(
name: string,
requiredmetadata?: UpdateFolderMetadata,
options?: { ifNew: UpdateFolderMetadata },
): Promise<WHFSFolder>;
generateName(
suggestion: string,
options?: { ignoreObject?: null | number; slugify?: boolean },
): Promise<string>;
getBaseURL(): Promise<null | string>;
list<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
): Promise<Pick<ListableFsObjectRow, "name" | "id" | "isFolder" | K>[]>;
listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
openFile(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile>;
openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
openFileOrFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile | WHFSFolder>;
openFileOrFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFile | WHFSFolder>;
openFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFolder>;
openFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFolder>;
openParent(
__namedParameters?: { allowRoot?: boolean },
): Promise<WHFSFolder>;
recycle(): Promise<void>;
refresh(options: { allowMissing: true }): Promise<boolean>;
refresh(options?: { allowMissing?: boolean }): Promise<true>;
update(metadata: UpdateFolderMetadata): Promise<void>;
}
dbrecord: FsObjectRow;
get created(): Instant;
get description(): string;
get id(): number;
get indexDoc(): null | number;
get isFile(): false;
get isFolder(): true;
get isPinned(): boolean;
get isUnlisted(): boolean;
get link(): null | string;
get modified(): Instant;
get name(): string;
get ordering(): number;
get parent(): null | number;
get parentSite(): null | number;
get sitePath(): null | string;
get title(): string;
get type(): string;
get whfsPath(): string;
_doUpdate(
metadata: UpdateFileMetadata | UpdateFolderMetadata,
): Promise<void>;
createFile(name: string, metadata?: CreateFileMetadata): Promise<WHFSFile>;
createFolder(
name: string,
metadata?: CreateFolderMetadata,
): Promise<WHFSFolder>;
delete(): Promise<void>;
describeType(): Promise<FolderTypeInfo>;
ensureFile(
name: string,
requiredmetadata?: UpdateFileMetadata,
options?: { ifNew: UpdateFileMetadata },
): Promise<WHFSFile>;
ensureFolder(
name: string,
requiredmetadata?: UpdateFolderMetadata,
options?: { ifNew: UpdateFolderMetadata },
): Promise<WHFSFolder>;
generateName(
suggestion: string,
options?: { ignoreObject?: null | number; slugify?: boolean },
): Promise<string>;
getBaseURL(): Promise<null | string>;
list<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
): Promise<Pick<ListableFsObjectRow, "name" | "id" | "isFolder" | K>[]>;
listInstances(options?: ListInstancesOptions): Promise<ListInstancesResult>;
openFile(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile>;
openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
openFileOrFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile | WHFSFolder>;
openFileOrFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFile | WHFSFolder>;
openFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFolder>;
openFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFolder>;
openParent(
__namedParameters?: { allowRoot?: boolean },
): Promise<WHFSFolder>;
recycle(): Promise<void>;
refresh(options: { allowMissing: true }): Promise<boolean>;
refresh(options?: { allowMissing?: boolean }): Promise<true>;
update(metadata: UpdateFolderMetadata): Promise<void>;
}
Hierarchy
- WHFSBaseObject
- WHFSFolder
Index
Properties
Accessors
Methods
Accessors
created
- get created(): Instant
Returns Instant
description
- get description(): string
Returns string
id
- get id(): number
Returns number
index Doc
- get indexDoc(): null | number
Returns null | number
is File
- get isFile(): false
Returns false
is Folder
- get isFolder(): true
Returns true
is Pinned
- get isPinned(): boolean
Returns boolean
is Unlisted
- get isUnlisted(): boolean
Returns boolean
link
- get link(): null | string
Returns null | string
modified
- get modified(): Instant
Returns Instant
name
- get name(): string
Returns string
ordering
- get ordering(): number
Returns number
parent
- get parent(): null | number
Returns null | number
parent Site
- get parentSite(): null | number
Returns null | number
site Path
- get sitePath(): null | string
Returns null | string
title
- get title(): string
Returns string
type
- get type(): string
Returns string
whfs Path
- get whfsPath(): string
Returns string
Methods
Protected_ do Update
Parameters
- metadata: UpdateFileMetadata | UpdateFolderMetadata
Returns Promise<void>
create File
Parameters
- name: string
Optionalmetadata: CreateFileMetadata
Returns Promise<WHFSFile>
create Folder
Parameters
- name: string
Optionalmetadata: CreateFolderMetadata
Returns Promise<WHFSFolder>
delete
Returns Promise<void>
describe Type
Returns Promise<FolderTypeInfo>
ensure File
- ensureFile(
name: string,
requiredmetadata?: UpdateFileMetadata,
options?: { ifNew: UpdateFileMetadata },
): Promise<WHFSFile>Parameters
- name: string
Optionalrequiredmetadata: UpdateFileMetadataOptionaloptions: { ifNew: UpdateFileMetadata }
Returns Promise<WHFSFile>
ensure Folder
- ensureFolder(
name: string,
requiredmetadata?: UpdateFolderMetadata,
options?: { ifNew: UpdateFolderMetadata },
): Promise<WHFSFolder>Parameters
- name: string
Optionalrequiredmetadata: UpdateFolderMetadataOptionaloptions: { ifNew: UpdateFolderMetadata }
Returns Promise<WHFSFolder>
generate Name
- generateName(
suggestion: string,
options?: { ignoreObject?: null | number; slugify?: boolean },
): Promise<string>Generate a unique name for a new object in this folder
Parameters
- suggestion: string
Suggested name for the new object. If this name is already taken, a counter will be appended to the name
- options: { ignoreObject?: null | number; slugify?: boolean } = {}
Options for generating the name
OptionalignoreObject?: null | numberIgnore this object when looking for a free name (usually refers to an object being renamed as it shouldn't clash with itself)
Optionalslugify?: booleanSlugify the suggested name, defaults to true
Returns Promise<string>
- suggestion: string
get Base URL
Get the base URL for items in this folder if it was published. Does not follow or use the indexDoc
Returns Promise<null | string>
- The base URL for this folder or an empty string if its site is not published
list
list Instances
Parameters
Optionaloptions: ListInstancesOptions
Returns Promise<ListInstancesResult>
open File
- openFile(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile>Parameters
- path: string
- options: OpenWHFSObjectOptions & { allowMissing: true }
Returns Promise<null | WHFSFile>
Parameters
- path: string
Optionaloptions: OpenWHFSObjectOptions
Returns Promise<WHFSFile>
open File Or Folder
- openFileOrFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile | WHFSFolder>Parameters
- path: string
- options: OpenWHFSObjectOptions & { allowMissing: true }
Returns Promise<null | WHFSFile | WHFSFolder>
Parameters
- path: string
Optionaloptions: OpenWHFSObjectOptions
Returns Promise<WHFSFile | WHFSFolder>
open Folder
- openFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFolder>Parameters
- path: string
- options: OpenWHFSObjectOptions & { allowMissing: true }
Returns Promise<null | WHFSFolder>
Parameters
- path: string
Optionaloptions: OpenWHFSObjectOptions
Returns Promise<WHFSFolder>
open Parent
Open the parent folder for this object
Parameters
- __namedParameters: { allowRoot?: boolean } = {}
Returns Promise<WHFSFolder>
recycle
Returns Promise<void>
refresh
Re-read cached data from the database, returns whether the object still exists
Parameters
- options: { allowMissing: true }
Returns Promise<boolean>
Re-read cached data from the database, throws when the object doesn't exist anymore
Parameters
Optionaloptions: { allowMissing?: boolean }
Returns Promise<true>
update
Parameters
- metadata: UpdateFolderMetadata
Returns Promise<void>
Describe this object's type