ConnectOptions

Options you can pass when establishing the connection to SketchUp.

All properties are optional — calling SketchUpApi.connect() with no arguments uses sensible defaults. The most common reason to provide options is to enable diagnostics logging during development or to tune chunk sizes for large models.

Example

// Connect with diagnostics enabled
await SketchUpApi.connect({
  clientDiagnostics: true,
  serverDiagnostics: true,
});

Properties

clientDiagnostics?

readonly optional clientDiagnostics?: boolean

When true, the SDK logs every message it receives from SketchUp. Useful for debugging communication issues.

queryChunkBatchSize?

readonly optional queryChunkBatchSize?: number

How many data chunks to send per message during a query. Higher values transfer more data per round-trip, which can speed up large queries. However, very large messages may degrade performance. Defaults to 8192.

replaceAlreadyConnected?

readonly optional replaceAlreadyConnected?: boolean

Whether to automatically reconnect if SketchUp reports an existing connection. When true (the default), if SketchUp responds with “already connected,” the SDK will disconnect the stale session and retry once. Set to false if you want to handle this situation yourself.

Since

SDK 2.26.2

serverDiagnostics?

readonly optional serverDiagnostics?: boolean

When true, SketchUp logs every message it receives from your extension. Useful for debugging communication issues.

whenOperationInProgress?

readonly optional whenOperationInProgress?: OperationInProgressResolution

Global configuration for how concurrent operations are handled.

Example

queue up all operations

await SketchUpApi.connect({whenOperationInProgress: 'queue'});

See

OperationOptions

Default

'error'

Since

SDK 2.36.0