Skip to content

Select theme

Select language

Start here
Build plugins
Structure
Applications
Ecosystem
Remote
Best practices
API guides
Project
- Releases
Reference
- @graftland/cli
  - Overview
  - Application
    Overview
    Classes
    Application
    ApplicationError
    Variables
    platform
    ProtocolOutput
  - bin
    Overview
  - Commands
    Overview
    Classes
    CommandConfigError
    CommandRegistrationError
    Commands
    Type Aliases
    Environment
  - index
    Overview
    Namespaces
    Check
    Check
    type-aliases
    Configuration
    variables
    Configuration
    inspect
    run
    Selection
    Manage
    functions
    remove
    Manage
    variables
    add
    addPlugin
    Start
    functions
    run
    interfaces
    Options
    Start
    References
    Application
    Commands
- @graftland/graft
  - Overview
  - Event
    Overview
    Interfaces
    Event
    HandlerOptions
    Type Aliases
    Middleware
    Next
    Origin
    Variables
    waterfall
    Functions
    bail
    emit
    filtered
    isWithin
    make
    makeOrigin
    middleware
    on
    once
    parallel
    settle
    within
  - Fork
    Overview
    Classes
    CleanupError
    ProbeError
    Interfaces
    Fork
    ForkTree
    Type Aliases
    ForkState
    Variables
    ForkState
  - Graft
    Overview
    Classes
    Graft
    ReplacementConflict
    ServiceConflict
    Interfaces
    Intercept
    Isolatable
    LogEntry
    PluginOptions
    ReplaceOptions
    Type Aliases
    CanReplace
    CompatibleReplacement
    CompatibleReplacements
    ReplacementFailure
    ReplacementPair
    ReplaceResult
    Variables
    forks
    layer
    logs
    plugin
    provide
    replace
    ReplacementFailure
    ReplaceResult
    transition
    Functions
    intercept
    resolve
  - index
    Overview
    References
    Event
    Fork
    Graft
    Manifest
    Plugin
    Release
    Transition
    Trust
  - Manifest
    Overview
    Classes
    ManifestError
    Interfaces
    Declaration
    Selection
    Type Aliases
    Diagnostic
    DirectoryIdentity
    Entry
    Host
    Manifest
    Operation
    Package
    PackageIdentity
    Placement
    Requirements
    Service
    Services
    Source
    Variables
    derive
    Diagnostic
    DirectoryIdentity
    Entry
    Host
    Identity
    Manifest
    Operation
    Package
    PackageIdentity
    Placement
    PublicEntry
    Requirements
    Service
    Services
    Source
    Functions
    check
    conflicts
    getEntry
    operationId
  - Plugin
    Overview
    Classes
    Optional
    Interfaces
    Definition
    Options
    ProvidedContract
    Tasks
    Type Aliases
    Dependency
    ErrorOf
    InputOf
    OperationComparison
    OperationIdentity
    Plugin
    Provided
    Required
    Requirements
    Update
    Variables
    Contract
    fork
    make
    OperationIdentity
    probe
    TypeId
    Functions
    compareOperations
    fromModule
    isOptional
    isPlugin
    layer
    optional
    service
  - Release
    Overview
    Classes
    ReleaseInterrupted
    Functions
    close
    scoped
  - Transition
    Overview
    Classes
    AdmissionRejected
    DriverError
    ManagedFork
    Unavailable
    Interfaces
    Candidate
    CandidateIdentity
    Description
    Driver
    Evidence
    Facade
    Generation
    GenerationEvent
    Invoke
    Policy
    Registration
    Request
    Result
    Termination
    Unit
    Type Aliases
    Outcome
    Phase
    Reason
    Variables
    assertUnmanaged
    CurrentInstance
    defaultPolicy
    generationHistoryLimit
    Outcome
    registerDriver
    Functions
    facade
    withUnmanaged
  - Trust
    Overview
    Classes
    ProjectionConflict
    RegistrationError
    Unapproved
    Interfaces
    Authority
    Comparison
    Publisher
    Type Aliases
    Projection
    ProjectionValue
    Publication
    View
    Variables
    check
    Projection
    ProjectionValue
    Publication
    publish
    register
    View
- @graftland/create
  - Overview
  - bin
    Overview
  - Command
    Overview
    Variables
    command
  - index
    Overview
    Classes
    AmbiguousPluginName
    CreateError
    InvalidName
    InvalidPackageManager
    PluginNotFound
    Interfaces
    Options
    Project
    Type Aliases
    TemplateName
    Variables
    checkTarget
    create
    Name
    pluginPackage
    pluginSpec
    TemplateName
    Functions
    hasShortName
- @graftland/hmr
  - Overview
  - index
    Overview
    Classes
    HmrError
    Interfaces
    Hmr
    ImportOptions
    Observation
    Options
    WatchOptions
    Type Aliases
    ReloadResult
    WatchResult
    Variables
    make
    WatchResult
- @graftland/loader
  - Overview
  - index
    Overview
    Namespaces
    ConfigSchema
    functions
    make
    interfaces
    Options
    Registration
    ConfigSchema
    Entry
    classes
    CyclicConfig
    Env
    functions
    checkAcyclic
    resolveEnv
    Entry
    type-aliases
    Entry
    NewEntry
    variables
    CurrentId
    Entries
    Entry
    NewEntry
    Select
    Group
    Group
    variables
    Group
    Include
    Include
    type-aliases
    Config
    variables
    Include
    Intercept
    classes
    InvalidIntercept
    UnregisteredReference
    functions
    layer
    make
    interfaces
    Registration
    Intercept
    variables
    Registry
    resolve
    Loader
    classes
    Loader
    LoaderClosed
    StoreError
    interfaces
    Store
    Loader
    type-aliases
    EditError
    variables
    newId
    plugin
    start
    ModuleResolver
    classes
    AmbiguousPluginName
    ModuleInvalid
    ModuleNotFound
    ModuleResolver
    functions
    candidates
    fromRecord
    layer
    observe
    interfaces
    ImportOptions
    Observation
    Options
    ResolutionEnvironment
    ModuleResolver
    variables
    make
    Watch
    Tree
    classes
    EntryNotFound
    InvalidOperation
    functions
    apply
    childrenOf
    ids
    pathOf
    validate
    validateGroup
    validateIds
    validateStructure
    Tree
    type-aliases
    Op
    Patch
    Path
    variables
    GroupEntries
    Op
    Variables
    ConfigDirectory
- @graftland/package-manager
  - Overview
  - index
    Overview
    Classes
    PackageManagerError
    RecoveryRequiredError
    UnsupportedFileTypeError
    Interfaces
    InstallResult
    Options
    PackageChange
    PackageManager
    PackageState
    SnapshotCleanupFailure
    StateDiff
    UserAgent
    Type Aliases
    Agent
    Changes
    Error
    State
    Variables
    Agent
    Changes
    detectAgent
    make
    PackageName
    published
    Functions
    agentFor
    diffState
    execPrefix
    installCommand
    parseUserAgent
    runPrefix
    References
    PackageManagerDeclaration
  - PackageManagerDeclaration
    Overview
    Type Aliases
    PackageManagerDeclaration
    Variables
    PackageManagerDeclaration
    PackageManagerName
- @graftland/plugin-http
  - Overview
  - Authorization
    Overview
    Classes
    Authorization
    AuthorizationConfigurationError
    InsufficientScope
    InvalidToken
    Principal
    TokenValidator
    Unauthorized
    ValidationUnavailable
    Type Aliases
    Protection
    Variables
    ScopeToken
  - Config
    Overview
    Type Aliases
    Config
    Variables
    Config
    JwtConfig
    OAuthConfig
  - Http
    Overview
    Classes
    InvalidMount
    Mounted
    RouteConflict
    Routes
    Routing
    Server
    Interfaces
    Mount
    Route
    RouteState
    Variables
    Mounts
    MountsChanged
    Functions
    advertise
    mount
  - index
    Overview
    Variables
    default
  - oauth
    Overview
    Variables
    default
  - oauth/jwt
    Overview
    Variables
    default
  - router
    Overview
    Variables
    default
  - schema
    Overview
    Functions
    entries
  - Testing
    Overview
    Classes
    ConformanceError
    Variables
    listener
- @graftland/plugin-http-api
  - Overview
  - Config
    Overview
    Type Aliases
    Config
    Variables
    Config
    Path
    UiConfig
  - HttpApis
    Overview
    Classes
    CompositionError
    Document
    GroupConflict
    ServingMount
    Interfaces
    Snapshot
    Variables
    advertise
    Groups
    GroupsChanged
    Functions
    serve
  - index
    Overview
    Variables
    default
  - scalar
    Overview
    Variables
    default
  - schema
    Overview
    Functions
    entries
  - swagger
    Overview
    Variables
    default
- @graftland/plugin-mcp-server
  - Overview
  - Catalog
    Overview
    Classes
    Conflict
    Interfaces
    Kind
    Offer
    Type Aliases
    RequestServices
    Variables
    Changed
    Offered
    Functions
    advertise
    enabledWhen
    offer
    own
  - Config
    Overview
    Type Aliases
    Config
    StdioConfig
    Variables
    Config
    HttpConfig
    ProtocolVersion
    StdioConfig
  - Errors
    Overview
    Classes
    StdioUnavailable
  - Extensions
    Overview
    Classes
    Conflict
    Variables
    Declared
    Functions
    declare
  - http
    Overview
    Variables
    default
  - index
    Overview
    Variables
    default
  - Middleware
    Overview
    Type Aliases
    Call
    Variables
    Middleware
    Visible
  - Projection
    Overview
    Classes
    Annotation
    ProjectionError
    Interfaces
    Binding
    Change
    Controller
    Description
    Prepared
    Type Aliases
    Metadata
    PortableSchema
    ToolFailure
    Variables
    Changed
    Metadata
    ToolFailure
    Functions
    offer
    operation
  - Prompts
    Overview
    Interfaces
    Prompt
    Type Aliases
    Registration
    Variables
    kind
    Functions
    offer
  - Resources
    Overview
    Interfaces
    Resource
    Template
    Variables
    kind
    templateKind
    Updated
    Functions
    offer
    template
    updated
  - schema
    Overview
    Functions
    entries
  - Server
    Overview
    Classes
    Server
    Interfaces
    Options
    Variables
    isolate
  - stdio
    Overview
    Variables
    default
  - Testing
    Overview
    Interfaces
    Connection
    Variables
    decode
    encode
    metadata
    transport
    Functions
    kindConformance
    response
    transportConformance
  - Tools
    Overview
    Interfaces
    Registration
    Type Aliases
    Services
    Undeclared
    Variables
    kind
    Functions
    offer
    plugin
- @graftland/plugin-otlp
  - Overview
  - Config
    Overview
    Type Aliases
    Config
    Http
    Reference
    Variables
    Config
    Http
    Reference
  - Exporter
    Overview
    Classes
    Exporter
    ExporterError
  - http
    Overview
    Variables
    default
    References
    Config
  - index
    Overview
    Variables
    default
    References
    Config
  - schema
    Overview
    Functions
    entries
  - Testing
    Overview
    Classes
    ConformanceError
    Functions
    exporter
- @graftland/plugin-release
  - Overview
  - approve-cli
    Overview
    Variables
    default
  - cli
    Overview
    Variables
    default
  - index
    Overview
    Namespaces
    Control
    Control
    type-aliases
    Reply
    Request
    variables
    call
    dispatch
    Reply
    Request
    serve
    Classes
    ReleaseError
    Releases
    Interfaces
    Applied
    Options
    Type Aliases
    Apply
    Build
    Change
    Config
    Diagnostic
    Entry
    Event
    Journal
    OutcomeSummary
    Plan
    Release
    SourceEntry
    Status
    Variables
    Apply
    build
    Build
    Change
    Config
    default
    Diagnostic
    Entry
    Event
    Id
    Journal
    OutcomeSummary
    Plan
    Release
    SourceEntry
    Status
    Functions
    plugin
    summarize
- @graftland/plugin-remote
  - Overview
  - Artifact
    Overview
    Classes
    ArtifactError
    Interfaces
    CaptureOptions
    Type Aliases
    Artifact
    Identity
    Variables
    Artifact
    capture
    directoryIdentity
    identify
    Identity
    implementation
    verify
  - Auth
    Overview
    Classes
    Authenticator
    Credentials
    Interfaces
    ClientCertificate
    TlsPolicy
    VerifiedCertificate
    Type Aliases
    AuthenticatorApi
    CredentialsApi
    Prepared
  - Capabilities
    Overview
    Classes
    Broker
    Denied
    Type Aliases
    FileRequest
    HttpRequest
    Variables
    FileRequest
    group
    HttpRequest
    make
    service
  - cli
    Overview
    Variables
    default
  - Config
    Overview
    Type Aliases
    Connect
    Listen
    Reference
    Variables
    Authentication
    Cli
    Connect
    Host
    Listen
    ManagedHost
    OrdinaryHost
    Reference
    Runner
    RunnerAuthentication
  - Conformance
    Overview
    Interfaces
    Cancellation
    Example
    Operation
    Request
    Session
    Suite
    Type Aliases
    DirectOptions
    Variables
    agreement
    direct
    roundTrip
    run
    References
    ConformanceError
  - Contract
    Overview
    Classes
    UndeclaredFailure
    Interfaces
    Contract
    Options
    Service
    Type Aliases
    ConfigSchema
    ErrorSchema
    OperationComparison
    RunnerContract
    Variables
    TypeId
    Functions
    compareOperations
    fromModule
    identity
    isContract
    make
    operation
    service
  - Errors
    Overview
    Classes
    AuthenticationFailed
    AuthenticatorUnavailable
    CredentialsError
    LocalTerminationTimeout
    MissingInstance
    ProcessExited
    RemoteEntryError
    RemoteError
    RemoteWithdrawn
    TransportError
  - host/auth/bearer
    Overview
    Variables
    Config
    default
  - host/auth/jwt
    Overview
    Variables
    default
    References
    Config
  - host/auth/mtls
    Overview
    Variables
    Config
    default
  - host/auth/none
    Overview
    Variables
    default
  - host/command
    Overview
    Classes
    CommandExited
    Interfaces
    Options
    Variables
    Config
    default
    Functions
    make
  - host/local
    Overview
    Variables
    default
  - host/unix
    Overview
    Interfaces
    Options
    Variables
    Config
    default
    properties
    Functions
    make
  - host/websocket
    Overview
    Interfaces
    Options
    Variables
    Config
    default
    Functions
    make
  - host/worker
    Overview
    Variables
    default
  - index
    Overview
    Classes
    RemoteTerminationUnconfirmed
    Interfaces
    ManagedOptions
    Options
    Type Aliases
    Authentication
    CandidateOptions
    CandidateOptions
    Connect
    CredentialSource
    CredentialToken
    Variables
    default
    Instance
    Functions
    candidate
    plugin
    References
    Artifact
    AuthenticationFailed
    AuthenticatorUnavailable
    Capabilities
    Conformance
    Contract
    CredentialsError
    LocalTerminationTimeout
    MissingInstance
    Policy
    ProcessExited
    Publication
    RemoteEntryError
    RemoteError
    RemoteWithdrawn
    Sandbox
    TransportError
    UndeclaredFailure
  - Policy
    Overview
    Classes
    Audit
    PolicyError
    Service
    Unapproved
    Interfaces
    Operations
    Type Aliases
    Approval
    Approve
    Assignment
    Grant
    Identity
    Policy
    ProjectionChange
    Statement
    Variables
    Approval
    Approve
    Assignment
    check
    Grant
    Identity
    install
    Policy
    ProjectionChange
    publish
    service
    Statement
    termination
  - Publication
    Overview
    Classes
    PublicationError
    Type Aliases
    EntryInput
    PackageInput
    Provenance
    Variables
    EntryInput
    generate
    inspectEntry
    PackageInput
    provenance
    Provenance
    record
    verify
    write
    Functions
    canonical
    declarations
  - runner
    Overview
    Variables
    default
  - runner/auth/bearer
    Overview
    Variables
    Config
    default
  - runner/auth/jwt
    Overview
    Variables
    ClockTolerance
    Config
    default
  - runner/auth/mtls
    Overview
    Variables
    Config
    default
    Functions
    make
  - runner/auth/none
    Overview
    Variables
    default
  - runner/stdio
    Overview
    Variables
    Config
    default
  - runner/unix
    Overview
    Variables
    Config
    default
  - runner/websocket
    Overview
    Variables
    Config
    default
  - Sandbox
    Overview
    Classes
    Launcher
    SandboxError
    Interfaces
    Launch
    Request
    Variables
    Current
    linux
  - schema
    Overview
    Functions
    entries
  - Testing
    Overview
    Classes
    ConformanceError
    Interfaces
    Capabilities
    Functions
    rejection
    transport
  - Transport
    Overview
    Classes
    Connector
    Listener
    Interfaces
    Channel
    ConnectorApi
    Handshake
    ListenerApi
    Properties
    Serving
    Type Aliases
    Accept
    Session

Select theme

Select language

On this page

Overview
Interfaces
Variables
Functions

On this page

Overview
Interfaces
Variables
Functions

host/websocket

Import path: @graftland/plugin-remote/host/websocket.

Interfaces

Section titled “Interfaces”

Options

Variables

Section titled “Variables”

Config
default

Functions

Section titled “Functions”

make