Function
| Static Public Summary | ||
| public |
checkMountpointPermission(req: *, res: *, method: *, readOnly: *, strict: *): * Checks permissions for given mountpoint |
|
| public |
createError(code: *, message: *): * Creates a new custom Error |
|
| public |
FS Settings adapter |
|
| public |
getPrefix(path: *) Gets prefix of a VFS path |
|
| public |
mountpointResolver(core: *): * Resolves a mountpoint |
|
| public |
Null Auth adapter |
|
| public |
Null Settings adapter |
|
| public |
parseFields(config: *): * Middleware for handling HTTP requests |
|
| public |
sanitize(filename: *): * Sanitizes a path |
|
| public |
streamFromRequest(req: *): * Gets the stream from a HTTP request |
|
| public |
system(core: Core, options: object): {"watch": *, "capabilities": *, "exists": *, "stat": *, "readdir": *, "readfile": *, "mkdir": *, "writefile": *, "rename": *, "copy": *, "unlink": *, "search": *, "touch": *, "realpath": *} System VFS adapter |
|
| public |
validateGroups(userGroups: *, method: *, mountpoint: *, strict: *): boolean Validates groups |
|
Static Public
public checkMountpointPermission(req: *, res: *, method: *, readOnly: *, strict: *): * source
import {checkMountpointPermission} from '@osjs/server/src/utils/vfs.js'Checks permissions for given mountpoint
Params:
| Name | Type | Attribute | Description |
| req | * | ||
| res | * | ||
| method | * | ||
| readOnly | * | ||
| strict | * |
Return:
| * |
public createError(code: *, message: *): * source
import {createError} from '@osjs/server/src/utils/vfs.js'Creates a new custom Error
Params:
| Name | Type | Attribute | Description |
| code | * | ||
| message | * |
Return:
| * |
public fs(core: Core, options: object): {"save": *, "load": *} source
import fs from '@osjs/server/src/adapters/settings/fs.js'FS Settings adapter
Return:
| {"save": *, "load": *} |
public getPrefix(path: *) source
import {getPrefix} from '@osjs/server/src/utils/vfs.js'Gets prefix of a VFS path
Params:
| Name | Type | Attribute | Description |
| path | * |
public mountpointResolver(core: *): * source
import {mountpointResolver} from '@osjs/server/src/utils/vfs.js'Resolves a mountpoint
Params:
| Name | Type | Attribute | Description |
| core | * |
Return:
| * |
public null(core: Core, options: object) source
import null from '@osjs/server/src/adapters/auth/null.js'Null Auth adapter
public null(core: Core, options: object) source
import null from '@osjs/server/src/adapters/settings/null.js'Null Settings adapter
public parseFields(config: *): * source
import {parseFields} from '@osjs/server/src/utils/vfs.js'Middleware for handling HTTP requests
Params:
| Name | Type | Attribute | Description |
| config | * |
Return:
| * |
public sanitize(filename: *): * source
import {sanitize} from '@osjs/server/src/utils/vfs.js'Sanitizes a path
Params:
| Name | Type | Attribute | Description |
| filename | * |
Return:
| * |
public streamFromRequest(req: *): * source
import {streamFromRequest} from '@osjs/server/src/utils/vfs.js'Gets the stream from a HTTP request
Params:
| Name | Type | Attribute | Description |
| req | * |
Return:
| * |
public system(core: Core, options: object): {"watch": *, "capabilities": *, "exists": *, "stat": *, "readdir": *, "readfile": *, "mkdir": *, "writefile": *, "rename": *, "copy": *, "unlink": *, "search": *, "touch": *, "realpath": *} source
import system from '@osjs/server/src/adapters/vfs/system.js'System VFS adapter
Return:
| {"watch": *, "capabilities": *, "exists": *, "stat": *, "readdir": *, "readfile": *, "mkdir": *, "writefile": *, "rename": *, "copy": *, "unlink": *, "search": *, "touch": *, "realpath": *} |
public validateGroups(userGroups: *, method: *, mountpoint: *, strict: *): boolean source
import {validateGroups} from '@osjs/server/src/utils/vfs.js'Validates groups
Params:
| Name | Type | Attribute | Description |
| userGroups | * | ||
| method | * | ||
| mountpoint | * | ||
| strict | * |