Interface ServicesOptions

Build options for [ServicesClient].

interface ServicesOptions {
    apiSecret?: string;
    apiSecretFromEnv?: boolean;
    metricsIntervalMs?: number;
    name?: string;
    sshKeyPem?: string;
}

Index

Properties

apiSecret? apiSecretFromEnv? metricsIntervalMs? name? sshKeyPem?

Properties

`Optional`apiSecret

apiSecret?: string

Encoded API secret string (services1...).

`Optional`apiSecretFromEnv

apiSecretFromEnv?: boolean

If true, read the API secret from IROH_SERVICES_API_SECRET.

`Optional`metricsIntervalMs

metricsIntervalMs?: number

Metrics push interval (ms). 0 disables interval pushes.

`Optional`name

name?: string

Optional endpoint name to register cloud-side.

`Optional`sshKeyPem

sshKeyPem?: string

Unencrypted PEM-encoded OpenSSH ed25519 private key.