This version of the module is deprecated: This package is deprecated. moonbit-community/proton should be preferred.

    justjavac/proton/command does not have a README file

    AppCommandApiDescriptor

    pub struct AppCommandApiDescriptor {
    api_name : String
    }

    One JavaScript-facing API descriptor exposed by a user app command extension.

    AppCommandApiDescriptor::api_name

    fn AppCommandApiDescriptor::api_name(self : AppCommandApiDescriptor) -> String

    AppCommandApiDescriptor::new

    fn AppCommandApiDescriptor::new(api_name : String) -> AppCommandApiDescriptor

    AppCommandExtensionContext

    pub struct AppCommandExtensionContext {
    host :
    AppCommandHost

    extension_id : String
    js_namespace : String
    options : Json?
    base_dir : String?
    }

    Runtime context passed to one user-process command extension during registration.

    AppCommandExtensionContext::base_dir

    AppCommandExtensionContext::emit

    async fn[Payload : ToJson] AppCommandExtensionContext::emit(self : AppCommandExtensionContext, event_name : String, payload : Payload) -> Unit

    AppCommandExtensionContext::extension_id

    fn AppCommandExtensionContext::extension_id(self : AppCommandExtensionContext) -> String

    AppCommandExtensionContext::js_namespace

    fn AppCommandExtensionContext::js_namespace(self : AppCommandExtensionContext) -> String

    AppCommandExtensionContext::new

    fn AppCommandExtensionContext::new(host :
    AppCommandHost
    , extension_id : String, js_namespace : String, options? : Json?, base_dir? : String?) -> AppCommandExtensionContext

    AppCommandExtensionContext::op

    fn[Payload :
    FromJson
    , Reply : ToJson] AppCommandExtensionContext::op(self : AppCommandExtensionContext, api_name : String, callback : (Payload) -> Reply, emits_events? : Bool) -> Unit

    AppCommandExtensionContext::op_async

    fn[Payload :
    FromJson
    , Reply : ToJson] AppCommandExtensionContext::op_async(self : AppCommandExtensionContext, api_name : String, callback : async (Payload) -> Reply, emits_events? : Bool) -> Unit

    AppCommandExtensionContext::op_async_result

    fn[Payload :
    FromJson
    , Reply : ToJson] AppCommandExtensionContext::op_async_result(self : AppCommandExtensionContext, api_name : String, callback : async (Payload) -> Result[Reply, String], emits_events? : Bool) -> Unit

    AppCommandExtensionContext::op_name

    fn AppCommandExtensionContext::op_name(self : AppCommandExtensionContext, api_name : String) -> String

    AppCommandExtensionContext::op_result

    fn[Payload :
    FromJson
    , Reply : ToJson] AppCommandExtensionContext::op_result(self : AppCommandExtensionContext, api_name : String, callback : (Payload) -> Result[Reply, String], emits_events? : Bool) -> Unit

    AppCommandExtensionContext::options

    AppCommandExtensionDescriptor

    pub struct AppCommandExtensionDescriptor {
    id : String
    js_namespace : String
    apis : Array[AppCommandApiDescriptor]
    scripts : Array[String]
    }

    JavaScript bridge metadata exposed by a user app command extension.

    AppCommandExtensionDescriptor::new

    fn AppCommandExtensionDescriptor::new(id : String, js_namespace : String, apis : Array[AppCommandApiDescriptor], scripts? : Array[String]) -> AppCommandExtensionDescriptor

    AppCommandExtensionRegistry

    pub struct AppCommandExtensionRegistry {
    specs : Map[String, AppCommandExtensionSpec]
    registration_order : Array[String]
    }

    Registry of command extension specs available to one user app process.

    AppCommandExtensionRegistry::get

    AppCommandExtensionRegistry::new

    AppCommandExtensionRegistry::ordered_names

    AppCommandExtensionRegistry::registered_ids

    fn AppCommandExtensionRegistry::registered_ids(self : AppCommandExtensionRegistry) -> Array[String]

    AppCommandExtensionRegistry::spec_map

    AppCommandExtensionSpec

    pub struct AppCommandExtensionSpec {
    id : String
    js_namespace : String
    apis : Array[AppCommandApiDescriptor]
    scripts : Array[String]
    dependencies : Array[String]
    register : (AppCommandExtensionContext) -> Result[Unit, String]
    on_destroy : (AppCommandExtensionContext) -> Unit
    }

    Declarative user-process command extension spec.

    AppCommandExtensionSpec::apis

    AppCommandExtensionSpec::dependencies

    fn AppCommandExtensionSpec::dependencies(self : AppCommandExtensionSpec) -> Array[String]

    AppCommandExtensionSpec::destroy

    AppCommandExtensionSpec::id

    AppCommandExtensionSpec::js_namespace

    fn AppCommandExtensionSpec::js_namespace(self : AppCommandExtensionSpec) -> String

    AppCommandExtensionSpec::new

    fn AppCommandExtensionSpec::new(id : String, js_namespace : String, apis : Array[AppCommandApiDescriptor], register : (AppCommandExtensionContext) -> Result[Unit, String], scripts? : Array[String], dependencies? : Array[String], on_destroy? : (AppCommandExtensionContext) -> Unit) -> AppCommandExtensionSpec

    AppCommandExtensionSpec::op_names

    fn AppCommandExtensionSpec::op_names(self : AppCommandExtensionSpec) -> Array[String]

    AppCommandExtensionSpec::register

    fn AppCommandExtensionSpec::register(self : AppCommandExtensionSpec, context : AppCommandExtensionContext) -> Result[Unit, String]

    AppCommandExtensionSpec::scripts

    AppCommandsConfig

    pub struct AppCommandsConfig {
    op_names : Array[String]
    extensions : Array[
    IpcExtensionDescriptor
    ]
    framework_extension_ids : Array[String]
    }

    Commands exposed by the user app process to the framework runtime.

    AppCommandsConfig::framework_extension_ids

    fn AppCommandsConfig::framework_extension_ids(self : AppCommandsConfig) -> Array[String]

    AppCommandsConfig::from_ipc_descriptors

    fn AppCommandsConfig::from_ipc_descriptors(op_names : Array[String], extensions : Array[
    IpcExtensionDescriptor
    ], framework_extension_ids : Array[String]) -> AppCommandsConfig

    AppCommandsConfig::new

    fn AppCommandsConfig::new(op_names : Array[String], extensions? : Array[AppCommandExtensionDescriptor], framework_extension_ids? : Array[String]) -> AppCommandsConfig

    AppCommandsConfig::op_names

    fn AppCommandsConfig::op_names(self : AppCommandsConfig) -> Array[String]

    app_command_extension_op_name

    fn app_command_extension_op_name(js_namespace : String, api_name : String) -> String

    app_command_js_property_is_reserved

    fn app_command_js_property_is_reserved(name : String) -> Bool

    Source Files