Home Reference Source

References

summary
public

C Auth

Authentication Handler

public

C Core

OS.js Server Core

public

OS.js Virtual Filesystem

public

OS.js Package Abstraction

public

OS.js Package Management

public

OS.js Settings Manager

public

TODO: typedef

public

Authentication Service Options

public

Authentication User Profile

public

TODO: typedef

public

Filesystem Service Adapter Option Map

public

Filesystem Internal Call Options

public

Filesystem Service Options

public
public

TODO: typedef

public

Package Options

public

Package Service Options

public

TODO: typedef

public

Settings Service Options

adapters/auth

summary
public

F null(core: Core, options: object)

Null Auth adapter

adapters/settings

summary
public

F fs(core: Core, options: object): {"save": *, "load": *}

FS Settings adapter

public

F null(core: Core, options: object)

Null Settings adapter

adapters/vfs

summary
public

F system(core: Core, options: object): {"watch": *, "exists": *, "stat": *, "readdir": *, "readfile": *, "mkdir": *, "writefile": *, "rename": *, "copy": *, "unlink": *, "search": *, "touch": *, "realpath": *}

System VFS adapter

providers

summary
public

OS.js Auth Service Provider

public

OS.js Core Service Provider

public

OS.js Package Service Provider

public

OS.js Settings Service Provider

public

OS.js Virtual Filesystem Service Provider

utils

summary
public

F checkMountpointPermission(req: *, res: *, method: *, readOnly: *, strict: *): *

Checks permissions for given mountpoint

public

F createError(code: *, message: *): *

Creates a new custom Error

public

F getPrefix(path: *)

Gets prefix of a VFS path

public

F mountpointResolver(core: *): *

Resolves a mountpoint

public

F parseFields(config: *): *

Middleware for handling HTTP requests

public

F sanitize(filename: *): *

Sanitizes a path

public

F streamFromRequest(req: *): *

Gets the stream from a HTTP request

public

F validateGroups(userGroups: *, method: *, mountpoint: *, strict: *): boolean

Validates groups

public

V errorCodes: {"ENOENT": number, "EACCES": number}

A map of error codes

public

V methodArguments: {"realpath": *, "exists": *, "stat": *, "readdir": *, "readfile": *, "writefile": *, "mkdir": *, "unlink": *, "touch": *, "search": *, "copy": *, "rename": *}

A map of methods and their arguments.