On this page
Overview
Provides complete workspace inspection, context, setup task, and Node installer clients without arbitrary command execution.
- Artifact
DevelopmentWorkspace.js· esm - Classification
public first party - Availability
Native bridge - Normalization
Complete plain-text inputs and provider result/error preserved.
Import and lifecycle
import * as module from '/arcane/modules/DevelopmentWorkspace.js';
The client itself performs no discovery; inspect, context, setup, and installNode delegate only to an injected or Arcane.development provider.
Application-facing behavior: default DevelopmentWorkspace and input validators; inspect(), context(), setup(), installNode().
Protocol and host implementation
Arcane.development This detail does not widen the application-facing API or grant authority.
Exports, signatures, parameters, and results
| Binding | Form | Declaration or signature | Parameter syntax |
|---|---|---|---|
default | default · class | class DevelopmentWorkspace | — |
contextQuery | function | function contextQuery(value) | value |
setupTaskId | function | function setupTaskId(value) | value |
workspaceRoot | function | function workspaceRoot(value) | value |
| Callable | Kind | Exact public signature | Parameter syntax |
|---|---|---|---|
DevelopmentWorkspace.inspect | public-member | inspect(root) | root |
DevelopmentWorkspace.context | public-member | context(root,query='') | root,query='' |
DevelopmentWorkspace.setup | public-member | setup(root,taskId) | root,taskId |
DevelopmentWorkspace.installNode | public-member | installNode() | — |
| Member | Kind | Exact public declaration | Parameter syntax |
|---|---|---|---|
DevelopmentWorkspace.constructor | constructor | constructor(api=globalThis.Arcane?.development) | api=globalThis.Arcane?.development |
DevelopmentWorkspace.available | get | get available() | — |
DevelopmentWorkspace.nodeInstallerAvailable | get | get nodeInstallerAvailable() | — |
DevelopmentWorkspace.require | method | require(method) | method |
DevelopmentWorkspace.inspect | method | inspect(root) | root |
DevelopmentWorkspace.context | method | context(root,query='') | root,query='' |
DevelopmentWorkspace.setup | method | setup(root,taskId) | root,taskId |
DevelopmentWorkspace.installNode | method | installNode() | — |
Parameter meanings and results
DevelopmentWorkspace(api) reports available and nodeInstallerAvailable. inspect(root), context(root, query), setup(root, taskId), and installNode() preserve complete provider results.
Events, side effects, and errors
Source-literal CustomEvent dispatches
No source-literal CustomEvent dispatch is part of this artifact.
Lifecycle and event flow
This artifact has no additional documented lifecycle event flow.
Direct coded failures
This artifact directly assigns no stable coded failure.
Exported Error subclasses
This artifact exports no Error subclass.
Documented failure behavior
- TypeError for missing or malformed-control-character root, query, or task id
- unavailable capability Error
- provider errors preserved
Availability and capabilities
Native bridge. Complete plain-text inputs and provider result/error preserved.
Native development-capability wrapper; the provider owns filesystem authorization, canonical paths, filtering, setup-task interpretation, and the fixed Node installer, with no arbitrary-command API.
Contract example
import DevelopmentWorkspace from '/arcane/modules/DevelopmentWorkspace.js';
const workspace=new DevelopmentWorkspace({
inspect:async root=>({root}),
context:async(root,query)=>({root,query}),
setup:async()=>({ok:true})
});
console.log(await workspace.inspect('C:\\Projects\\demo'));