secure-exec TypeScript SDK - v0.3.0-rc.1
    Preparing search index...

    secure-exec TypeScript SDK - v0.3.0-rc.1

    Namespaces

    protocol

    Enumerations

    DisposeReason
    FilesystemOperation
    GuestFilesystemOperation
    GuestRuntimeKind
    PermissionMode
    ProcessSnapshotStatus
    RootFilesystemEntryEncoding
    RootFilesystemEntryKind
    RootFilesystemMode
    SignalDispositionAction
    StreamChannel
    VmLifecycleState
    WasmPermissionTier

    Classes

    FrameRpcTransport
    HostProtocolFrameFactory
    NodeRuntime
    PendingResponseRegistry
    SidecarProcess
    SidecarProcessError
    SidecarProcessExited
    SidecarProtocolClient
    StdioFrameTransport
    StdioSidecarProcess
    StdioSidecarProtocolClient

    Interfaces

    BindingDefinition
    CallbackExtEnvelope
    ChunkedLocalMountConfig
    ChunkedS3MountConfig
    FrameRpcTransportOptions
    GuestFilesystemContentResult
    HostDirectoryMount
    HostToolExample
    LengthPrefixedPayload
    LiveEventFrame
    LiveExtEnvelope
    LiveFsPermissionRule
    LiveGuestFilesystemStat
    LiveMountDescriptor
    LivePatternPermissionRule
    LivePermissionsPolicy
    LiveProcessSnapshotEntry
    LiveProjectedModuleDescriptor
    LiveRegisteredHostCallbackDefinition
    LiveRegisteredHostCallbackExample
    LiveRequestFrame
    LiveResponseFrame
    LiveRulePermissions
    LiveSidecarRequestFrame
    LiveSidecarResponseFrame
    LiveSignalHandlerRegistration
    LiveSocketStateEntry
    LiveSoftwareDescriptor
    MountConfigJsonObject
    NativeMountPluginDescriptor
    NodeModulesMount
    NodeRuntimeBootTiming
    NodeRuntimeCreateOptions
    NodeRuntimeExecOptions
    NodeRuntimeExecResult
    NodeRuntimeFetchInput
    NodeRuntimeFetchResponse
    NodeRuntimeListener
    NodeRuntimeListenerQuery
    NodeRuntimeProcess
    NodeRuntimeResidentRunner
    NodeRuntimeResidentRunnerExecOptions
    NodeRuntimeRunResult
    NodeRuntimeSpawnOptions
    NodeRuntimeWaitForListenerOptions
    ObjectS3MountConfig
    S3MountCredentialsConfig
    SidecarProtocolClientOptions
    SidecarSpawnOptions
    StdioFrameTransportOptions
    StdioSidecarProcessSpawnOptions
    StdioSidecarProtocolClientSpawnOptions

    Type Aliases

    AuthenticatedResponse
    AuthenticateRequest
    BootstrapRootFilesystemRequest
    BoundUdpSnapshotResponse
    BundledBaseFilesystemLower
    CallbackSidecarRequestPayload
    CallbackSidecarResponsePayload
    ClassifiedFrame
    ClassifiedSidecarWrittenProtocolFrame
    CloseStdinRequest
    ConfigureVmRequest
    ConnectionOwnership
    CreateLayerRequest
    CreateOverlayRequest
    CreateVmRequest
    DisposeVmRequest
    EventFrame
    EventPayload
    ExecuteRequest
    ExportSnapshotRequest
    ExtEnvelope
    FilesystemResultResponse
    FindBoundUdpRequest
    FindListenerRequest
    FsPermissionRule
    FsPermissionRuleSet
    FsPermissionScope
    GetProcessSnapshotRequest
    GetSignalStateRequest
    GetZombieTimerCountRequest
    GuestFilesystemCallRequest
    GuestFilesystemContentEncoding
    GuestFilesystemResultResponse
    GuestFilesystemStat
    HostCallbackRequest
    HostCallbackResultResponse
    HostCallbacksRegisteredResponse
    HostFilesystemCallRequest
    i32
    i64
    ImportSnapshotRequest
    JsBridgeCallRequest
    JsBridgeResultResponse
    JsonUtf8
    KillProcessRequest
    LayerCreatedResponse
    LayerSealedResponse
    ListenerSnapshotResponse
    LivePermissionMode
    LivePermissionScope
    LiveProtocolFrame
    LiveRequestPayload
    LiveResponsePayload
    LiveRootFilesystemDescriptor
    LiveRootFilesystemEntry
    LiveRootFilesystemEntryEncoding
    LiveRootFilesystemLowerDescriptor
    LiveSidecarPlacement
    LiveSidecarRequestHandler
    LiveSidecarRequestPayload
    LiveSidecarResponsePayload
    LiveSidecarWrittenProtocolFrame
    MountConfigJsonPrimitive
    MountConfigJsonValue
    MountDescriptor
    MountPluginDescriptor
    NodeRuntimeBootTimingPhase
    NodeRuntimeResidentRunnerOptions
    OpenSessionRequest
    OverlayCreatedResponse
    OwnershipScope
    PatternPermissionRule
    PatternPermissionRuleSet
    PatternPermissionScope
    PermissionDecisionResponse
    PermissionsPolicy
    PersistenceFlushedResponse
    PersistenceFlushRequest
    PersistenceLoadRequest
    PersistenceStateResponse
    ProcessExitedEvent
    ProcessKilledResponse
    ProcessOutputEvent
    ProcessSnapshotEntry
    ProcessSnapshotResponse
    ProcessStartedResponse
    ProjectedModuleDescriptor
    ProtocolFrame
    ProtocolFramePayloadCodec
    ProtocolSchema
    RegisteredHostCallbackDefinition
    RegisteredHostCallbackExample
    RegisterHostCallbacksRequest
    RejectedResponse
    RequestFrame
    RequestId
    RequestPayload
    ResponseFrame
    ResponsePayload
    RootFilesystemBootstrappedResponse
    RootFilesystemDescriptor
    RootFilesystemEntry
    RootFilesystemLowerDescriptor
    RootFilesystemSnapshotResponse
    SealLayerRequest
    SessionOpenedResponse
    SessionOwnership
    SidecarPlacement
    SidecarPlacementExplicit
    SidecarPlacementShared
    SidecarRequestFrame
    SidecarRequestPayload
    SidecarResponseFrame
    SidecarResponsePayload
    SignalHandlerRegistration
    SignalStateResponse
    SnapshotExportedResponse
    SnapshotImportedResponse
    SnapshotRootFilesystemLower
    SnapshotRootFilesystemRequest
    SocketStateEntry
    SoftwareDescriptor
    StdinClosedResponse
    StdinWrittenResponse
    StructuredEvent
    TransportPayloadCodec
    u16
    u32
    u64
    VmConfiguredResponse
    VmCreatedResponse
    VmDisposedResponse
    VmFetchRequest
    VmFetchResponse
    VmLifecycleEvent
    VmOwnership
    WriteStdinRequest
    ZombieTimerCountResponse

    Variables

    DEFAULT_SIDECAR_EVENT_BUFFER_CAPACITY
    DEFAULT_SIDECAR_FORCE_EXIT_MS
    DEFAULT_SIDECAR_FRAME_TIMEOUT_MS
    DEFAULT_SIDECAR_GRACEFUL_EXIT_MS
    LENGTH_PREFIX_BYTES

    Functions

    bigIntToSafeNumber
    chunkedLocalMountPlugin
    chunkedS3MountPlugin
    classifySidecarWrittenProtocolFrame
    decodeBareProtocolFrame
    decodeGuestFilesystemContent
    decodeJsonFramePayload
    decodeProtocolFrame
    decodeProtocolFramePayload
    decodeRootFilesystemDescriptor
    encodeBareProtocolFrame
    encodeGuestFilesystemContent
    encodeJsonFramePayload
    encodeLengthPrefixedPayload
    encodeProtocolFrame
    encodeProtocolFramePayload
    encodeRootFilesystemDescriptor
    errorSidecarResponsePayload
    fromGeneratedExtEnvelope
    fromGeneratedGuestFilesystemStat
    fromGeneratedProcessSnapshotEntry
    fromGeneratedResponsePayload
    fromGeneratedRootFilesystemEntry
    fromGeneratedSidecarRequestPayload
    fromGeneratedSidecarWrittenProtocolFrame
    fromGeneratedSocketStateEntry
    isMatchingSidecarResponsePayload
    objectS3MountPlugin
    parseJsonUtf8
    readAuthenticatedResponse
    readAuthenticateRequest
    readBootstrapRootFilesystemRequest
    readBoundUdpSnapshotResponse
    readCloseStdinRequest
    readConfigureVmRequest
    readConnectionOwnership
    readCreateOverlayRequest
    readCreateVmRequest
    readDisposeReason
    readDisposeVmRequest
    readEventFrame
    readEventPayload
    readExecuteRequest
    readExportSnapshotRequest
    readExtEnvelope
    readFilesystemOperation
    readFilesystemResultResponse
    readFindBoundUdpRequest
    readFindListenerRequest
    readFsPermissionRule
    readFsPermissionRuleSet
    readFsPermissionScope
    readGetSignalStateRequest
    readGuestFilesystemCallRequest
    readGuestFilesystemOperation
    readGuestFilesystemResultResponse
    readGuestFilesystemStat
    readGuestRuntimeKind
    readHostCallbackRequest
    readHostCallbackResultResponse
    readHostCallbacksRegisteredResponse
    readHostFilesystemCallRequest
    readImportSnapshotRequest
    readJsBridgeCallRequest
    readJsBridgeResultResponse
    readJsonUtf8
    readKillProcessRequest
    readLayerCreatedResponse
    readLayerSealedResponse
    readListenerSnapshotResponse
    readMountDescriptor
    readMountPluginDescriptor
    readOpenSessionRequest
    readOverlayCreatedResponse
    readOwnershipScope
    readPatternPermissionRule
    readPatternPermissionRuleSet
    readPatternPermissionScope
    readPermissionDecisionResponse
    readPermissionMode
    readPermissionsPolicy
    readPersistenceFlushedResponse
    readPersistenceFlushRequest
    readPersistenceLoadRequest
    readPersistenceStateResponse
    readProcessExitedEvent
    readProcessKilledResponse
    readProcessOutputEvent
    readProcessSnapshotEntry
    readProcessSnapshotResponse
    readProcessSnapshotStatus
    readProcessStartedResponse
    readProjectedModuleDescriptor
    readProtocolFrame
    readProtocolSchema
    readRegisteredHostCallbackDefinition
    readRegisteredHostCallbackExample
    readRegisterHostCallbacksRequest
    readRejectedResponse
    readRequestFrame
    readRequestId
    readRequestPayload
    readResponseFrame
    readResponsePayload
    readRootFilesystemBootstrappedResponse
    readRootFilesystemDescriptor
    readRootFilesystemEntry
    readRootFilesystemEntryEncoding
    readRootFilesystemEntryKind
    readRootFilesystemLowerDescriptor
    readRootFilesystemMode
    readRootFilesystemSnapshotResponse
    readSealLayerRequest
    readSessionOpenedResponse
    readSessionOwnership
    readSidecarPlacement
    readSidecarPlacementExplicit
    readSidecarPlacementShared
    readSidecarRequestFrame
    readSidecarRequestPayload
    readSidecarResponseFrame
    readSidecarResponsePayload
    readSignalDispositionAction
    readSignalHandlerRegistration
    readSignalStateResponse
    readSnapshotExportedResponse
    readSnapshotImportedResponse
    readSnapshotRootFilesystemLower
    readSocketStateEntry
    readSoftwareDescriptor
    readStdinClosedResponse
    readStdinWrittenResponse
    readStreamChannel
    readStructuredEvent
    readVmConfiguredResponse
    readVmCreatedResponse
    readVmDisposedResponse
    readVmFetchRequest
    readVmFetchResponse
    readVmLifecycleEvent
    readVmLifecycleState
    readVmOwnership
    readWasmPermissionTier
    readWriteStdinRequest
    readZombieTimerCountResponse
    resolvePublishedSidecarBinary
    resolveSidecarRequestFramePayload
    stringifyJsonUtf8
    toExactArrayBuffer
    toExactUint8Array
    toGeneratedExtEnvelope
    toGeneratedFilesystemPermissionScope
    toGeneratedMountDescriptor
    toGeneratedPatternPermissionScope
    toGeneratedPermissionsPolicy
    toGeneratedProjectedModuleDescriptor
    toGeneratedProtocolFrame
    toGeneratedRequestPayload
    toGeneratedRootFilesystemDescriptor
    toGeneratedRootFilesystemEntry
    toGeneratedRootFilesystemLower
    toGeneratedSidecarPlacement
    toGeneratedSidecarResponsePayload
    toGeneratedSoftwareDescriptor
    toLiveProtocolSchema
    tryDecodeLengthPrefixedPayload
    writeAuthenticatedResponse
    writeAuthenticateRequest
    writeBootstrapRootFilesystemRequest
    writeBoundUdpSnapshotResponse
    writeCloseStdinRequest
    writeConfigureVmRequest
    writeConnectionOwnership
    writeCreateOverlayRequest
    writeCreateVmRequest
    writeDisposeReason
    writeDisposeVmRequest
    writeEventFrame
    writeEventPayload
    writeExecuteRequest
    writeExportSnapshotRequest
    writeExtEnvelope
    writeFilesystemOperation
    writeFilesystemResultResponse
    writeFindBoundUdpRequest
    writeFindListenerRequest
    writeFsPermissionRule
    writeFsPermissionRuleSet
    writeFsPermissionScope
    writeGetSignalStateRequest
    writeGuestFilesystemCallRequest
    writeGuestFilesystemOperation
    writeGuestFilesystemResultResponse
    writeGuestFilesystemStat
    writeGuestRuntimeKind
    writeHostCallbackRequest
    writeHostCallbackResultResponse
    writeHostCallbacksRegisteredResponse
    writeHostFilesystemCallRequest
    writeImportSnapshotRequest
    writeJsBridgeCallRequest
    writeJsBridgeResultResponse
    writeJsonUtf8
    writeKillProcessRequest
    writeLayerCreatedResponse
    writeLayerSealedResponse
    writeListenerSnapshotResponse
    writeMountDescriptor
    writeMountPluginDescriptor
    writeOpenSessionRequest
    writeOverlayCreatedResponse
    writeOwnershipScope
    writePatternPermissionRule
    writePatternPermissionRuleSet
    writePatternPermissionScope
    writePermissionDecisionResponse
    writePermissionMode
    writePermissionsPolicy
    writePersistenceFlushedResponse
    writePersistenceFlushRequest
    writePersistenceLoadRequest
    writePersistenceStateResponse
    writeProcessExitedEvent
    writeProcessKilledResponse
    writeProcessOutputEvent
    writeProcessSnapshotEntry
    writeProcessSnapshotResponse
    writeProcessSnapshotStatus
    writeProcessStartedResponse
    writeProjectedModuleDescriptor
    writeProtocolFrame
    writeProtocolSchema
    writeRegisteredHostCallbackDefinition
    writeRegisteredHostCallbackExample
    writeRegisterHostCallbacksRequest
    writeRejectedResponse
    writeRequestFrame
    writeRequestId
    writeRequestPayload
    writeResponseFrame
    writeResponsePayload
    writeRootFilesystemBootstrappedResponse
    writeRootFilesystemDescriptor
    writeRootFilesystemEntry
    writeRootFilesystemEntryEncoding
    writeRootFilesystemEntryKind
    writeRootFilesystemLowerDescriptor
    writeRootFilesystemMode
    writeRootFilesystemSnapshotResponse
    writeSealLayerRequest
    writeSessionOpenedResponse
    writeSessionOwnership
    writeSidecarPlacement
    writeSidecarPlacementExplicit
    writeSidecarPlacementShared
    writeSidecarRequestFrame
    writeSidecarRequestPayload
    writeSidecarResponseFrame
    writeSidecarResponsePayload
    writeSignalDispositionAction
    writeSignalHandlerRegistration
    writeSignalStateResponse
    writeSnapshotExportedResponse
    writeSnapshotImportedResponse
    writeSnapshotRootFilesystemLower
    writeSocketStateEntry
    writeSoftwareDescriptor
    writeStdinClosedResponse
    writeStdinWrittenResponse
    writeStreamChannel
    writeStructuredEvent
    writeVmConfiguredResponse
    writeVmCreatedResponse
    writeVmDisposedResponse
    writeVmFetchRequest
    writeVmFetchResponse
    writeVmLifecycleEvent
    writeVmLifecycleState
    writeVmOwnership
    writeWasmPermissionTier
    writeWriteStdinRequest
    writeZombieTimerCountResponse

    References

    Sidecar → SidecarProcess