Interface Site
interface Site {
get id(): number;
get name(): string;
get outputFolder(): string;
get outputWeb(): null | number;
get webRoot(): null | string;
getWebDesign(): Promise<string>;
getWebFeatures(): Promise<null | string[]>;
list<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
options?: ListFSOptions,
): Promise<ListFSResult<K>[]>;
listRecursive<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
options?: ListFSRecursiveOptions,
): Promise<ListFSRecursiveResult<K>[]>;
openFile(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile>;
openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
openFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFolder>;
openFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFolder>;
update(
updates: UpdateableSiteSettings,
): Promise<{ applied: () => Promise<void> }>;
}
get id(): number;
get name(): string;
get outputFolder(): string;
get outputWeb(): null | number;
get webRoot(): null | string;
getWebDesign(): Promise<string>;
getWebFeatures(): Promise<null | string[]>;
list<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
options?: ListFSOptions,
): Promise<ListFSResult<K>[]>;
listRecursive<K extends keyof ListableFsObjectRow = never>(
keys?: K[],
options?: ListFSRecursiveOptions,
): Promise<ListFSRecursiveResult<K>[]>;
openFile(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFile>;
openFile(path: string, options?: OpenWHFSObjectOptions): Promise<WHFSFile>;
openFolder(
path: string,
options: OpenWHFSObjectOptions & { allowMissing: true },
): Promise<null | WHFSFolder>;
openFolder(
path: string,
options?: OpenWHFSObjectOptions,
): Promise<WHFSFolder>;
update(
updates: UpdateableSiteSettings,
): Promise<{ applied: () => Promise<void> }>;
}
Index
Accessors
Methods
Accessors
id
- get id(): number
Returns number
name
- get name(): string
Site name
Returns string
output
- get outputFolder(): string
Folder inside the webserver where the site is published
Returns string
output
- get outputWeb(): null | number
ID of the webserver to which the site is published, null if unpublished
Returns null | number
web
- get webRoot(): null | string
Absolute URL where the site is published, or null if the site is not published
Returns null | string
Methods
get
Get the webdesign for this site
Returns Promise<string>
get
Get enabled webfeatures for this site
Returns Promise<null | string[]>
list
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>
update
Update site settings
Parameters
- updates: UpdateableSiteSettings
Returns Promise<{ applied: () => Promise<void> }>
Site primary key (matches root folder id)