Class WHFSFolder
Hierarchy
- WHFSBaseObject
- WHFSFolder
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
- dbrecord: FsObjectRow
- typens: string
Returns WHFSFolder
Accessors
creation
- get creationDate(): Instant
Returns Instant
id
- get id(): number
Returns number
index
- get indexDoc(): null | number
Returns null | number
is
- get isFile(): false
Returns false
is
- get isFolder(): true
Returns true
is
- get isPinned(): boolean
Returns boolean
link
- get link(): null | string
Returns null | string
modification
- get modificationDate(): Instant
Returns Instant
name
- get name(): string
Returns string
parent
- get parent(): null | number
Returns null | number
parent
- get parentSite(): null | number
Returns null | number
site
- get sitePath(): null | string
Returns null | string
title
- get title(): string
Returns string
type
- get type(): string
Returns string
whfs
- get whfsPath(): string
Returns string
Methods
Protected_do
Parameters
- metadata: UpdateFileMetadata | UpdateFolderMetadata
Returns Promise<void>
create
Parameters
- name: string
Optionalmetadata: CreateFileMetadata
Returns Promise<WHFSFile>
create
Parameters
- name: string
Optionalmetadata: CreateFolderMetadata
Returns Promise<WHFSFolder>
delete
Returns Promise<void>
ensure
- ensureFile(
name: string,
requiredmetadata?: UpdateFileMetadata,
options?: { ifNew: UpdateFileMetadata },
): Promise<WHFSFile>Parameters
- name: string
Optionalrequiredmetadata: UpdateFileMetadataOptionaloptions: { ifNew: UpdateFileMetadata }
Returns Promise<WHFSFile>
ensure
- ensureFolder(
name: string,
requiredmetadata?: UpdateFolderMetadata,
options?: { ifNew: UpdateFolderMetadata },
): Promise<WHFSFolder>Parameters
- name: string
Optionalrequiredmetadata: UpdateFolderMetadataOptionaloptions: { ifNew: UpdateFolderMetadata }
Returns Promise<WHFSFolder>
generate
- generateName(
suggestion: string,
__namedParameters?: { ignoreObject?: null | number; slugify?: boolean },
): Promise<string>Parameters
- suggestion: string
Suggested name for the new object. If this name is already taken, a counter will be appended to the name
- __namedParameters: { ignoreObject?: null | number; slugify?: boolean } = {}
Returns Promise<string>
- suggestion: string
get
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
open
- 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
- 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
Open the parent folder for this object
Parameters
- __namedParameters: { allowRoot?: boolean } = {}
Returns Promise<WHFSFolder>
recycle
Returns Promise<void>
update
Parameters
- metadata: UpdateFolderMetadata
Returns Promise<void>
Generate a unique name for a new object in this folder