IModelHostOptions Interface
Options for startup
Implemented by
Properties
| Name | Type | Description | |
|---|---|---|---|
| allowSharedChannel | boolean | undefined | Automatically enable shared channel when opening iModels for read/write (see Working With Channels). | |
| appAssetsDir | string | undefined | The directory where application assets are found. | |
| authorizationClient | AuthorizationClient | undefined | The AuthorizationClient used to obtain AccessTokens. | |
| cacheDir | string | undefined | Root of the directory holding all the files that iTwin.js caches | |
| compressCachedTiles | boolean | undefined | Whether to compress cached tiles. | |
| enableOpenTelemetry | boolean | undefined | Whether to enable OpenTelemetry tracing. | |
| maxTileCacheDbSize | number | undefined | The maximum size in bytes to which a local sqlite database used for caching tiles can grow before it is purged of least-recently-used tiles. | |
| profileName | string | undefined | The name of the Profile subdirectory of cacheDir for this process. | |
| restrictTileUrlsByClientIp | boolean | undefined | Whether to restrict tile cache URLs by client IP address (if available). | |
| tileCacheAzureCredentials | AzureBlobStorageCredentials | undefined | The Azure blob storage credentials to use for the tile cache service. | |
| tileCacheStorage | ServerStorage | undefined | ||
| workspace | WorkspaceOpts | undefined | Options for creating the appWorkspace |
Defined in
- core/backend/src/IModelHost.ts Line 94
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.