@dxos/client
    Preparing search index...

    Class Config

    Global configuration object. NOTE: Config objects are immutable.

    Index

    Constructors

    constructor

    Accessors

    values

    Methods

    find get getOrThrow

    Constructors

    • Creates an immutable instance.

      Parameters

      • Optionalconfig: MessageInit<Config>
      • ...objects: MessageInit<Config>[]

      Returns Config

    Accessors

    • get values(): Config

      Returns an immutable config JSON object.

      Returns Config

    Methods

    • Get unique key.

      Type Parameters

      • T = any

      Parameters

      • path: string
      • test: object

      Returns undefined | T

    • Returns the given config property.

      Type Parameters

      • K extends
            | "version"
            | "package"
            | "runtime"
            | "runtime.services.iceProviders"
            | "package.license"
            | "package.repos"
            | "package.modules"
            | "runtime.app"
            | "runtime.services"
            | "runtime.kube"
            | "runtime.client"
            | "runtime.keys"
            | "runtime.cli"
            | "runtime.props"
            | "runtime.system"
            | "runtime.agent"
            | "runtime.client.log"
            | "runtime.client.storage"
            | "runtime.client.enableSnapshots"
            | "runtime.client.snapshotInterval"
            | "runtime.client.invitationExpiration"
            | "runtime.client.remoteSource"
            | "runtime.client.remoteSourceAuthenticationToken"
            | "runtime.client.devtoolsProxy"
            | "runtime.client.lazySpaceOpen"
            | "runtime.client.disableP2pReplication"
            | "runtime.client.enableVectorIndexing"
            | "runtime.client.edgeFeatures"
            | "runtime.client.observabilityGroup"
            | "runtime.client.signalTelemetryEnabled"
            | "runtime.client.singleClientMode"
            | "runtime.client.servicesMode"
            | "runtime.client.automergeCredentials"
            | "runtime.client.queryExecutor"
            | "runtime.client.log.filter"
            | "runtime.client.log.prefix"
            | "runtime.client.storage.persistent"
            | "runtime.client.storage.keyStore"
            | "runtime.client.storage.dataStore"
            | "runtime.client.storage.dataRoot"
            | "runtime.client.storage.spaceFragmentation"
            | "runtime.client.storage.sqliteMode"
            | "runtime.client.edgeFeatures.signaling"
            | "runtime.client.edgeFeatures.feedReplicator"
            | "runtime.client.edgeFeatures.subductionReplicator"
            | "runtime.client.edgeFeatures.agents"
            | "runtime.app.org"
            | "runtime.app.theme"
            | "runtime.app.website"
            | "runtime.app.publicUrl"
            | "runtime.app.build"
            | "runtime.app.build.timestamp"
            | "runtime.app.build.version"
            | "runtime.app.build.commitHash"
            | "runtime.app.build.branch"
            | `runtime.app.env.${string}`
            | "runtime.cli.channel"
            | "runtime.cli.app"
            | "runtime.cli.nodePath"
            | "runtime.cli.console"
            | "runtime.cli.mdns"
            | "runtime.cli.signal"
            | "runtime.cli.npmClient"
            | "runtime.cli.app.serve"
            | "runtime.cli.app.serve.config"
            | "runtime.cli.app.serve.loginApp"
            | "runtime.cli.app.serve.keyPhrase"
            | "runtime.cli.console.config"
            | "runtime.cli.console.channel"
            | "runtime.cli.console.package"
            | "runtime.cli.console.bin"
            | "runtime.cli.mdns.config"
            | "runtime.cli.mdns.channel"
            | "runtime.cli.mdns.package"
            | "runtime.cli.mdns.bin"
            | "runtime.cli.signal.config"
            | "runtime.cli.signal.channel"
            | "runtime.cli.signal.package"
            | "runtime.cli.signal.bin"
            | "runtime.props.title"
            | "runtime.services.signaling"
            | "runtime.services.app"
            | "runtime.services.kube"
            | "runtime.services.dxns"
            | "runtime.services.ipfs"
            | "runtime.services.ice"
            | "runtime.services.machine"
            | "runtime.services.bot"
            | "runtime.services.publisher"
            | "runtime.services.supervisor"
            | "runtime.services.tunneling"
            | "runtime.services.faasd"
            | "runtime.services.agentHosting"
            | "runtime.services.edge"
            | "runtime.services.ai"
            | "runtime.services.hub"
            | "runtime.services.sandbox"
            | "runtime.services.edgeServices"
            | "runtime.services.app.prefix"
            | "runtime.services.app.server"
            | "runtime.services.kube.publicUrl"
            | "runtime.services.kube.endpoints"
            | "runtime.services.kube.endpoints.services"
            | "runtime.services.kube.endpoints.logs"
            | "runtime.services.kube.endpoints.cert"
            | "runtime.services.dxns.server"
            | "runtime.services.dxns.accountUri"
            | "runtime.services.dxns.address"
            | "runtime.services.dxns.account"
            | "runtime.services.dxns.faucet"
            | "runtime.services.ipfs.server"
            | "runtime.services.ipfs.gateway"
            | "runtime.services.ipfs.serverAuthSecret"
            | "runtime.services.machine.doAccessToken"
            | "runtime.services.machine.githubAccessToken"
            | "runtime.services.machine.githubUsername"
            | "runtime.services.machine.dnsDomain"
            | "runtime.services.machine.npmAccessToken"
            | "runtime.services.bot.proxy"
            | "runtime.services.publisher.server"
            | "runtime.services.supervisor.server"
            | "runtime.services.tunneling.server"
            | "runtime.services.faasd.gateway"
            | "runtime.services.faasd.username"
            | "runtime.services.faasd.password"
            | "runtime.services.agentHosting.server"
            | "runtime.services.agentHosting.type"
            | "runtime.services.edge.url"
            | "runtime.services.ai.server"
            | "runtime.services.hub.url"
            | "runtime.services.hub.authUrl"
            | "runtime.services.sandbox.url"
            | "runtime.system.debug"
            | "runtime.kube.port"
            | "runtime.kube.env"
            | "runtime.kube.host"
            | "runtime.kube.autoupdate"
            | "runtime.kube.https"
            | "runtime.kube.p2p"
            | "runtime.kube.confhost"
            | "runtime.kube.alias"
            | "runtime.kube.monitoring"
            | "runtime.kube.trace"
            | "runtime.kube.telemetry"
            | "runtime.kube.gravity"
            | "runtime.kube.appTunneling"
            | "runtime.kube.bots"
            | "runtime.kube.ipfsApiAuthorizations"
            | "runtime.kube.autoupdate.interval"
            | "runtime.kube.autoupdate.enabled"
            | "runtime.kube.https.enabled"
            | "runtime.kube.https.port"
            | "runtime.kube.https.email"
            | "runtime.kube.https.certfile"
            | "runtime.kube.https.keyfile"
            | "runtime.kube.https.dnsprovider"
            | "runtime.kube.p2p.port"
            | "runtime.kube.p2p.privatekey"
            | "runtime.kube.p2p.bootstrap"
            | "runtime.kube.monitoring.interval"
            | "runtime.kube.monitoring.enabled"
            | "runtime.kube.monitoring.endpoint"
            | "runtime.kube.trace.disabled"
            | "runtime.kube.telemetry.disabled"
            | "runtime.kube.telemetry.tags"
            | "runtime.kube.gravity.disabled"
            | "runtime.kube.gravity.name"
            | "runtime.kube.gravity.logDir"
            | "runtime.kube.appTunneling.enabled"
            | "runtime.kube.appTunneling.port"
            | "runtime.kube.appTunneling.commandTemplate"
            | "runtime.kube.appTunneling.outputRe"
            | "runtime.kube.bots.interval"
            | "runtime.kube.bots.enabled"
            | "runtime.agent.plugins"

      Parameters

      • key: K

        A key in the config object. Can be a nested property with keys separated by dots: 'services.signal.server'.

      • OptionaldefaultValue: DeepIndex<Config, ParseKey<K>>

        Default value to return if option is not present in the config.

      Returns undefined | DeepIndex<Config, ParseKey<K>>

      The config value or undefined if the option is not present.

    • Returns the given config property or throw if it doesn't exist.

      Type Parameters

      • K extends
            | "version"
            | "package"
            | "runtime"
            | "runtime.services.iceProviders"
            | "package.license"
            | "package.repos"
            | "package.modules"
            | "runtime.app"
            | "runtime.services"
            | "runtime.kube"
            | "runtime.client"
            | "runtime.keys"
            | "runtime.cli"
            | "runtime.props"
            | "runtime.system"
            | "runtime.agent"
            | "runtime.client.log"
            | "runtime.client.storage"
            | "runtime.client.enableSnapshots"
            | "runtime.client.snapshotInterval"
            | "runtime.client.invitationExpiration"
            | "runtime.client.remoteSource"
            | "runtime.client.remoteSourceAuthenticationToken"
            | "runtime.client.devtoolsProxy"
            | "runtime.client.lazySpaceOpen"
            | "runtime.client.disableP2pReplication"
            | "runtime.client.enableVectorIndexing"
            | "runtime.client.edgeFeatures"
            | "runtime.client.observabilityGroup"
            | "runtime.client.signalTelemetryEnabled"
            | "runtime.client.singleClientMode"
            | "runtime.client.servicesMode"
            | "runtime.client.automergeCredentials"
            | "runtime.client.queryExecutor"
            | "runtime.client.log.filter"
            | "runtime.client.log.prefix"
            | "runtime.client.storage.persistent"
            | "runtime.client.storage.keyStore"
            | "runtime.client.storage.dataStore"
            | "runtime.client.storage.dataRoot"
            | "runtime.client.storage.spaceFragmentation"
            | "runtime.client.storage.sqliteMode"
            | "runtime.client.edgeFeatures.signaling"
            | "runtime.client.edgeFeatures.feedReplicator"
            | "runtime.client.edgeFeatures.subductionReplicator"
            | "runtime.client.edgeFeatures.agents"
            | "runtime.app.org"
            | "runtime.app.theme"
            | "runtime.app.website"
            | "runtime.app.publicUrl"
            | "runtime.app.build"
            | "runtime.app.build.timestamp"
            | "runtime.app.build.version"
            | "runtime.app.build.commitHash"
            | "runtime.app.build.branch"
            | `runtime.app.env.${string}`
            | "runtime.cli.channel"
            | "runtime.cli.app"
            | "runtime.cli.nodePath"
            | "runtime.cli.console"
            | "runtime.cli.mdns"
            | "runtime.cli.signal"
            | "runtime.cli.npmClient"
            | "runtime.cli.app.serve"
            | "runtime.cli.app.serve.config"
            | "runtime.cli.app.serve.loginApp"
            | "runtime.cli.app.serve.keyPhrase"
            | "runtime.cli.console.config"
            | "runtime.cli.console.channel"
            | "runtime.cli.console.package"
            | "runtime.cli.console.bin"
            | "runtime.cli.mdns.config"
            | "runtime.cli.mdns.channel"
            | "runtime.cli.mdns.package"
            | "runtime.cli.mdns.bin"
            | "runtime.cli.signal.config"
            | "runtime.cli.signal.channel"
            | "runtime.cli.signal.package"
            | "runtime.cli.signal.bin"
            | "runtime.props.title"
            | "runtime.services.signaling"
            | "runtime.services.app"
            | "runtime.services.kube"
            | "runtime.services.dxns"
            | "runtime.services.ipfs"
            | "runtime.services.ice"
            | "runtime.services.machine"
            | "runtime.services.bot"
            | "runtime.services.publisher"
            | "runtime.services.supervisor"
            | "runtime.services.tunneling"
            | "runtime.services.faasd"
            | "runtime.services.agentHosting"
            | "runtime.services.edge"
            | "runtime.services.ai"
            | "runtime.services.hub"
            | "runtime.services.sandbox"
            | "runtime.services.edgeServices"
            | "runtime.services.app.prefix"
            | "runtime.services.app.server"
            | "runtime.services.kube.publicUrl"
            | "runtime.services.kube.endpoints"
            | "runtime.services.kube.endpoints.services"
            | "runtime.services.kube.endpoints.logs"
            | "runtime.services.kube.endpoints.cert"
            | "runtime.services.dxns.server"
            | "runtime.services.dxns.accountUri"
            | "runtime.services.dxns.address"
            | "runtime.services.dxns.account"
            | "runtime.services.dxns.faucet"
            | "runtime.services.ipfs.server"
            | "runtime.services.ipfs.gateway"
            | "runtime.services.ipfs.serverAuthSecret"
            | "runtime.services.machine.doAccessToken"
            | "runtime.services.machine.githubAccessToken"
            | "runtime.services.machine.githubUsername"
            | "runtime.services.machine.dnsDomain"
            | "runtime.services.machine.npmAccessToken"
            | "runtime.services.bot.proxy"
            | "runtime.services.publisher.server"
            | "runtime.services.supervisor.server"
            | "runtime.services.tunneling.server"
            | "runtime.services.faasd.gateway"
            | "runtime.services.faasd.username"
            | "runtime.services.faasd.password"
            | "runtime.services.agentHosting.server"
            | "runtime.services.agentHosting.type"
            | "runtime.services.edge.url"
            | "runtime.services.ai.server"
            | "runtime.services.hub.url"
            | "runtime.services.hub.authUrl"
            | "runtime.services.sandbox.url"
            | "runtime.system.debug"
            | "runtime.kube.port"
            | "runtime.kube.env"
            | "runtime.kube.host"
            | "runtime.kube.autoupdate"
            | "runtime.kube.https"
            | "runtime.kube.p2p"
            | "runtime.kube.confhost"
            | "runtime.kube.alias"
            | "runtime.kube.monitoring"
            | "runtime.kube.trace"
            | "runtime.kube.telemetry"
            | "runtime.kube.gravity"
            | "runtime.kube.appTunneling"
            | "runtime.kube.bots"
            | "runtime.kube.ipfsApiAuthorizations"
            | "runtime.kube.autoupdate.interval"
            | "runtime.kube.autoupdate.enabled"
            | "runtime.kube.https.enabled"
            | "runtime.kube.https.port"
            | "runtime.kube.https.email"
            | "runtime.kube.https.certfile"
            | "runtime.kube.https.keyfile"
            | "runtime.kube.https.dnsprovider"
            | "runtime.kube.p2p.port"
            | "runtime.kube.p2p.privatekey"
            | "runtime.kube.p2p.bootstrap"
            | "runtime.kube.monitoring.interval"
            | "runtime.kube.monitoring.enabled"
            | "runtime.kube.monitoring.endpoint"
            | "runtime.kube.trace.disabled"
            | "runtime.kube.telemetry.disabled"
            | "runtime.kube.telemetry.tags"
            | "runtime.kube.gravity.disabled"
            | "runtime.kube.gravity.name"
            | "runtime.kube.gravity.logDir"
            | "runtime.kube.appTunneling.enabled"
            | "runtime.kube.appTunneling.port"
            | "runtime.kube.appTunneling.commandTemplate"
            | "runtime.kube.appTunneling.outputRe"
            | "runtime.kube.bots.interval"
            | "runtime.kube.bots.enabled"
            | "runtime.agent.plugins"

      Parameters

      • key: K

        A key in the config object. Can be a nested property with keys separated by dots: 'services.signal.server'.

      Returns NonNullable<DeepIndex<Config, ParseKey<K>>>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods