WRTE 0.0.1 | Documentation

WRTE

0.0.1

kernel ▸
- Static members
- .main
- .init
- .init
- .init
- .name
- .version
- .build
proc ▸
- Static members
- .Pid
- .ProcessStatus
- .Process
- .getProcess
- .getProcessForWindow
- .ArgV
- .spawn
- .sanitizeArgv
- .ProcessInfo
- .ps
- .Capability
ipc ▸
- Static members
- .MessageType
- .Message
- .makeReply
- .errorReply
- .Cid
- .Channel
- .Handler
Sandbox ▸
- Instance members
- #path
- #iframe
- #window
- #terminate
- #postMessage
sandbox.blob
vfs ▸
- Static members
- .contentHandler
- .Path
- .Volume
- .mount
- .unmount
- .getMounts
- .assign
- .unassign
- .getAssigns
- .resolvePath
- .splitPath
- .normalizePath
- .resolveAssigns
tunables ▸
- Static members
- .VOLUME_NAME_REGEXP
- .MAX_ASSIGN_RESOLVE_ATTEMPTS
Window ▸
- Instance members
- #_frame
- #_head
- #_style
- #_body
- #_content
- #_dragStartEvent
- #preventKeys
- #show
- #hide
- #close
- #setPosition
- #setContent
- #setStyle
- #dragStart
- #dragEnd
- #onKeyPress
Rect
lib ▸
- Static members
- .id
EventEmitter ▸
- Instance members
- #on
- #off
- #emit
Callback
fillReply
parseArgs
file
notifyNewChannel
process

Need help reading this?

kernel

Static Members

▸ main()

kernel/main.js

Web main() entry point.

main()

▸ init()

kernel/ipc.js

IPC init()ialization.

init()

▸ init()

kernel/vfs.js

VFS init()ialization.

init()

▸ init()

kernel/proc.js

PROC init()ialization.

init()

▸ name

kernel/index.js

name

Type: string

▸ version

kernel/index.js

version

Type: string

▸ build

kernel/index.js

build

Type: string

proc

Static Members

▸ Pid

kernel/proc.js

Pid

Type: string

▸ ProcessStatus

kernel/proc.js

ProcessStatus

Type: ("SPAWNING" | "RUNNING" | "TERMINATING" | "TERMINATED")

▸ new Process()

kernel/proc.js

Process class. Wrapper for iframe+WebWorker untrusted code {Sandbox}. Used to spawn, control and terminate underlying WebWorker process.

new Process()

Extends EventEmitter

Instance Members

▸ pid

kernel/proc.js

pid

Type: Pid

▸ path

kernel/proc.js

path

Type: string

▸ argv

kernel/proc.js

argv

Type: Array<any>

▸ status

kernel/proc.js

status

Type: ProcessStatus

▸ status

kernel/proc.js

status

Type: ProcessStatus

Returns

ProcessStatus

▸ status

kernel/proc.js

status

Type: ProcessStatus

Parameters

status (ProcessStatus)

▸ sandbox

kernel/proc.js

sandbox

Type: Sandbox

▸ channels

kernel/proc.js

channels

Type: {}

▸ capabilities

kernel/proc.js

capabilities

Type: Array<Capability>

▸ terminate()

kernel/proc.js

terminate()

▸ postMessage(msg)

kernel/proc.js

postMessage(msg: Message)

Parameters

msg (Message)

▸ openChannel()

kernel/proc.js

openChannel(): Channel

Returns

Channel

▸ getChannel(chan)

kernel/proc.js

getChannel(chan: string): Channel

Parameters

chan (string)

Returns

Channel

▸ closeChannel(chan)

kernel/proc.js

closeChannel(chan: string): void

Parameters

chan (string)

Returns

void

▸ getProcess(pid)

kernel/proc.js

Get Process object by Pid.

getProcess(pid: Pid?): (Process | null)

Parameters

pid (Pid?) Process ID.

Returns

(Process | null): Process .

▸ getProcessForWindow(window)

kernel/proc.js

Get Process object by its iframe window.

getProcessForWindow(window: WindowProxy): (Process | null)

Parameters

window (WindowProxy) Sandbox iframe window reference.

Returns

(Process | null): Process .

▸ ArgV

kernel/proc.js

ArgV

Type: Array<any>

▸ spawn(path, argv)

kernel/proc.js

Spawn a new Process.

spawn(path: string, argv: ArgV): (Pid | null)

Parameters

path (string) VFS Path to process script.

argv

(ArgV
            = [])

Arguments array.

Returns

(Pid | null): Process Id.

▸ sanitizeArgv(argv)

kernel/proc.js

Mangle argv for display purposes.

sanitizeArgv(argv: ArgV): Array<any>

Parameters

argv (ArgV) Arguments array.

Returns

Array<any>: Mangled array.

▸ ProcessInfo

kernel/proc.js

ProcessInfo

Type: {pid: Pid, path: string, argv: Array<any>, status: ProcessStatus}

Properties

pid (Pid)

path (string)

argv (Array<any>)

status (ProcessStatus)

▸ ps()

kernel/proc.js

Get _Process_es information.

ps(): Array<ProcessInfo>

Returns

Array<ProcessInfo>: Process information array.

▸ Capability

kernel/proc.js

Capability

Type: ("spawn" | "mount" | "window:text" | "window:canvas")

ipc

Static Members

▸ MessageType

kernel/ipc.js

MessageType

▸ Message

kernel/ipc.js

Message

Type: {type: MessageType, id: string?, payload: (string | Object | ArrayBuffer)?, process: (Pid | null)?, path: (string | null)?, channel: Cid?}

Properties

type (MessageType)

id (string?)

payload ((string | Object | ArrayBuffer)?)

process ((Pid | null)?)

path ((string | null)?)

channel (Cid?)

▸ makeReply(reply, message)

kernel/ipc.js

Build a reply to a Message.

makeReply(reply: Message, message: Message): Message

Parameters

reply (Message) Reply Message to be filled.

message (Message) Message instance reply is a response to.

Returns

Message: Reply Message .

▸ errorReply(error, message)

kernel/ipc.js

Build an error reply to a Message.

errorReply(error: string, message: Message): Message

Parameters

error (string) Error type to be returned.

message (Message) Message instance error is a response to.

Returns

Message: Error Message .

▸ Cid

kernel/ipc.js

Cid

Type: string

▸ Channel

kernel/ipc.js

Channel type. Describes two-way communication channel between processes or process and path handler

Channel

Type: {id: Cid, pid: Pid?, endpoint: Pid?, path: string?, onTerminate: function (): void?, handler: Handler?, meta: Object?, send: function (msg: Message): void?}

Properties

id (Cid)

pid (Pid?)

endpoint (Pid?)

path (string?)

onTerminate (function (): void?)

handler (Handler?)

meta (Object?)

send (function (msg: Message): void?)

▸ Handler

kernel/vfs.js

Handler function

Handler

Type: function (to: (Path | Channel), from: Process, msg: Message): void

Parameters

to (any) Path or Channel the message belongs to.

from (any) Process sending the message .

msg (any) Message object.

Sandbox

kernel/sandbox.js

Process Sandbox is responsible for launching an untrusted process in WebWorker thread and jailing it in IFrame sandbox. This restricts what a Process can do to what is allowed to WebWorker thread (not much besides web access) and what is accessible by sending and receiving messages from the kernel (and indirectly other _Process_es).

new Sandbox(id: string, path: string)

Parameters

id (string)

path (string)

Instance Members

▸ path

kernel/sandbox.js

path

Type: string

▸ iframe

kernel/sandbox.js

iframe

Type: HTMLIFrameElement?

▸ window

kernel/sandbox.js

window

Type: WindowProxy?

▸ terminate()

kernel/sandbox.js

terminate()

▸ postMessage(msg)

kernel/sandbox.js

postMessage(msg: {})

Parameters

msg ({})

sandbox.blob

kernel/sandbox.blob.js

IFrame proxy code for WebWorker. This code works in an IFrame sandbox as an intermediary between kernel and process code working in WebWorker it creates.

sandbox.blob(origin: string, name: string, path: string): void

Parameters

origin (string) Origin of parent window.

name (string) Name of WebWorker inside (for tracking purposes).

path (string) Originating code path (for logging purposes).

Returns

void

vfs

Static Members

▸ contentHandler(to, from, msg)

kernel/vfs.js

Handler function for built-in VFS process handlers. It serves the content of virtual internal: file to be launched as VFS handler process.

contentHandler(to: (Path | Channel), from: Process, msg: Message): void

Parameters

to ((Path | Channel)) Request destination. Either Channel or Path .

from (Process) Requesting Process .

msg (Message) Request Message .

Returns

void

▸ Path

kernel/vfs.js

Path

Type: string

▸ Volume

kernel/vfs.js

Volume

Type: string

▸ mount(volume, handler, argv)

kernel/vfs.js

Mounts a Process or internal: handler on VFS volume.

VFS volume can be handled either by spawning a dedicated process processing messages sent to VFS paths or by handler function provided internally ba kernel.

mount(volume: Volume, handler: (Path | Handler), argv: Array<any>)

Parameters

volume (Volume) Volume name.

handler ((Path | Handler)) Path to process content or handler function.

argv

(Array<any>
            = [])

Array of arguments.

▸ unmount(volume)

kernel/vfs.js

Unmounts _Volume handler.

unmount(volume: Volume)

Parameters

volume (Volume) Volume name.

▸ getMounts()

kernel/vfs.js

List all mounts and handlers.

getMounts()

▸ assign(source, dest)

kernel/vfs.js

Create a mapping from one Path to another Path.

VFS will replace source part of Path with dest, every time it resolves a Path - keeping the part that does not match. This allows mapping a part of VFS tree under other Path, including shadowing already existing VFS trees.

assign(source: Path, dest: Path): boolean

Parameters

source (Path) Part of Path to be replaced.

dest (Path) Path replacement.

Returns

boolean: Success boolean.

▸ unassign(source)

kernel/vfs.js

Removes an assign.

unassign(source: Path)

Parameters

source (Path) Assign source part of Path .

▸ getAssigns()

kernel/vfs.js

List all _Assign_s.

getAssigns(): Array<[Path, Path]>

Returns

Array<[Path, Path]>: Array of [source, dest] Path parts.

▸ resolvePath(full)

kernel/vfs.js

Map a Path to its Handler.

resolvePath(full: Path): [Handler?, Path]

Parameters

full (Path) Path string.

Returns

[Handler?, Path]: Array of [ Handler , normalized Path ] .

▸ splitPath(full)

kernel/vfs.js

Split Path to Volume part and rest.

splitPath(full: Path): [Volume?, Path]

Parameters

full (Path) Path to split.

Returns

[Volume?, Path]: Array of [Volume, rest] parts.

▸ normalizePath(path)

kernel/vfs.js

Normalizes a Path removing repeating directory separators, resolving . and .. references, and leading and trailing separators.

normalizePath(path: Path): any

Parameters

path (Path) Path to normalize.

Returns

any: Resolved Path .

▸ resolveAssigns(path)

kernel/vfs.js

Pass Path over _Assign_s mapping resolving all _Assign_s. Possibly multiple times (until reaching MAX_ASSIGN_RESOLVE_ATTEMPTS).

resolveAssigns(path: Path): Path

Parameters

path (Path) Path to resolve.

Returns

Path: Resolved and normalized Path .

tunables

Static Members

▸ VOLUME_NAME_REGEXP

kernel/tunables.js

VOLUME_NAME_REGEXP

Type: string

▸ MAX_ASSIGN_RESOLVE_ATTEMPTS

kernel/tunables.js

MAX_ASSIGN_RESOLVE_ATTEMPTS

Type: number

Window

kernel/window.js

Creates application Window visible to the user. Handles interactions by emitting events.

new Window()

Extends EventEmitter

Instance Members

▸ _frame

kernel/window.js

_frame

Type: HTMLIFrameElement

▸ _head

kernel/window.js

_head

Type: HTMLHeadElement

▸ _style

kernel/window.js

_style

Type: HTMLStyleElement

▸ _body

kernel/window.js

_body

Type: HTMLElement

▸ _content

kernel/window.js

_content

Type: HTMLElement

▸ _dragStartEvent

kernel/window.js

_dragStartEvent

Type: DragEvent

▸ preventKeys

kernel/window.js

preventKeys

Type: Array<string>

▸ show(parent)

kernel/window.js

show(parent: HTMLElement?)

Parameters

parent (HTMLElement?)

▸ hide()

kernel/window.js

hide()

▸ close()

kernel/window.js

close()

▸ setPosition(position)

kernel/window.js

setPosition(position: Rect)

Parameters

position (Rect)

▸ setContent(data)

kernel/window.js

setContent(data: string)

Parameters

data (string)

▸ setStyle(data)

kernel/window.js

setStyle(data: string)

Parameters

data (string)

▸ dragStart(evt)

kernel/window.js

dragStart(evt: DragEvent)

Parameters

evt (DragEvent)

▸ dragEnd(evt)

kernel/window.js

dragEnd(evt: DragEvent)

Parameters

evt (DragEvent)

▸ onKeyPress(evt)

kernel/window.js

onKeyPress(evt: KeyboardEvent)

Parameters

evt (KeyboardEvent)

Rect

kernel/window.js

Rect

Type: {x: number, y: number, width: number, height: number}

Properties

x (number)

y (number)

width (number)

height (number)

lib

Static Members

▸ id(len)

lib/id.js

Generate random ID string.

id(len: number): any

Parameters

len

(number
            = 7)

Length of generated ID.

Returns

any: ID string.

EventEmitter

lib/event-emitter.js

Very simplistic EventEmitter.

new EventEmitter()

Instance Members

▸ on(event, cb)

lib/event-emitter.js

on(event: string, cb: Callback)

Parameters

event (string)

cb (Callback)

▸ off(event, cb)

lib/event-emitter.js

off(event: string, cb: Callback)

Parameters

event (string)

cb (Callback)

▸ emit(event, data)

lib/event-emitter.js

emit(event: string, data: ({} | string))

Parameters

event (string)

data (({} | string))

Callback

lib/event-emitter.js

Callback

Type: function (({} | string)): void

fillReply

kernel/ipc.js

Copy attributes needed for a reply to a Message.

fillReply(reply: Message, message: Message): Message

Parameters

reply (Message) Reply Message to be filled.

message (Message) Message instance reply is a response to.

Returns

Message: Reply Message .

parseArgs

lib/args.js

parse argument options

Return an argument object argv populated with the array arguments from args. argv. contains all the arguments that didn't have an option associated with them. Numeric-looking arguments will be returned as numbers unless opts.string or opts.boolean is set for that argument name. Any arguments after '--' will not be parsed and will end up in argv..

parseArgs(args: Array<string>, opts: Opts): ArgV

Parameters

args (Array<string>) Arguments array.

opts (Opts) Parse options.

Returns

ArgV: argv object.

file

lib/file.js

file(path: string, payload: {}?): Promise<File>

Parameters

path (string)

payload ({}?)

Returns

Promise<File>

notifyNewChannel

kernel/ipc.js

Helper function to notify a Process about new Channel creation.

notifyNewChannel(process: Process, channel: Cid, data: {}, message: Message): void

Parameters

process (Process) Process object instance.

channel (Cid) Channel ID.

data ({}) Channel data (process: Pid or path: Path ).

message (Message) OPEN Message it is a reply to.

Returns

void

process

lib/process.js

process(name: string): Promise<Process>

Parameters

name (string)

Returns

Promise<Process>