Errors

Import from @infrared-city/infrared-sdk.

A parts run that cannot be joined because a part did not produce a result.

failedParts names them; runParts(input, { retryFrom: error.schedule }) (or runAndWait with the same option) sends only those parts again.

Extends

• Error

Constructors

Constructor

new AnalysisPartsError(message, failedParts, schedule, downloadFailedParts?, options?): AnalysisPartsError

Parameters

Returns

AnalysisPartsError

Overrides

Error.constructor

Properties

downloadFailedParts

readonly downloadFailedParts: readonly string\[\] = []

Parts whose result is on the server but did not download.

---

failedParts

readonly failedParts: readonly string\[\]

Parts a retryFrom sends again; empty when every part has a result.

---

name

readonly name: "AnalysisPartsError" = "AnalysisPartsError"

Overrides

Error.name

---

schedule

readonly schedule: PartsSchedule

The run, with its accepted jobs.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when resuming a saved schedule from an older SDK version that recorded a capability probe with an unknown outcome. Resuming would repeat work whose billing state is unknown. This SDK no longer submits probe jobs, so schedules it writes never raise this.

areaSchedule is the saved schedule and acceptedProbeJobIds the probe job ids it recorded.

Extends

• Error

Constructors

Constructor

new AreaGeometryProbeError(areaSchedule, acceptedProbeJobIds): AreaGeometryProbeError

Parameters

Returns

AreaGeometryProbeError

Overrides

Error.constructor

Properties

acceptedProbeJobIds

readonly acceptedProbeJobIds: readonly string\[\]

---

areaSchedule

readonly areaSchedule: AreaSchedule

---

name

readonly name: "AreaGeometryProbeError" = "AreaGeometryProbeError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when the API accepted a job whose geometry reference turned out to be invalid. The accepted jobs cannot produce a trusted result, so the run stops.

areaSchedule is the schedule recorded so far and acceptedJobIds lists the jobs the API accepted with the invalid reference, so you can find them for billing or support.

Extends

• Error

Constructors

Constructor

new AreaGeometryReferenceError(areaSchedule, acceptedJobIds): AreaGeometryReferenceError

Parameters

Returns

AreaGeometryReferenceError

Overrides

Error.constructor

Properties

acceptedJobIds

readonly acceptedJobIds: readonly string\[\]

---

areaSchedule

readonly areaSchedule: AreaSchedule

---

name

readonly name: "AreaGeometryReferenceError" = "AreaGeometryReferenceError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

Thrown by InfraredClient.runAreaAndWait and by an item of runAreaStream when the run ended without its full result: a tile failed, a finished job did not download, or a submit is uncertain. The key lists name the tiles; failedJobs names the jobs for billing or support.

Extends

• Error

Constructors

Constructor

new AreaRunError(message, failedKeys, lostKeys, uncertainKeys, failedJobs, totalJobs): AreaRunError

Parameters

Returns

AreaRunError

Overrides

Error.constructor

Properties

failedJobs

readonly failedJobs: readonly string\[\]

The job ids of the failed and the lost tiles that have one.

---

failedKeys

readonly failedKeys: readonly string\[\]

Tiles with no job, and tiles whose job failed on the server.

---

lostKeys

readonly lostKeys: readonly string\[\]

Tiles whose job succeeded and whose result did not download.

---

name

readonly name: "AreaRunError" = "AreaRunError"

Overrides

Error.name

---

totalJobs

readonly totalJobs: number

The number of jobs the run made.

---

uncertainKeys

readonly uncertainKeys: readonly string\[\]

Tiles that may have a job the SDK cannot name.

---

Import from @infrared-city/infrared-sdk.

Thrown by InfraredClient.runAreaAndWait when the run does not finish within areaTimeout seconds.

Extends

• Error

Constructors

Constructor

new AreaTimeoutError(message, areaState): AreaTimeoutError

Parameters

Returns

AreaTimeoutError

Overrides

Error.constructor

Properties

areaState

readonly areaState: AreaState

The run's counts at the moment it timed out.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when a resume is refused because the saved schedule's configuration hash was computed by an older SDK and cannot be compared with this one.

Start a fresh run with the same inputs; tiles that already succeeded are unaffected.

Extends

• Error

Constructors

Constructor

new ConfigHashPolicyError(message): ConfigHashPolicyError

Parameters

Returns

ConfigHashPolicyError

Overrides

Error.constructor

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when the core could not be initialised, for example because it could not be fetched or compiled, or because the options passed to initializeCore() are invalid.

Extends

• Error

Extended by

• CoreTerminalError

Constructors

Constructor

new CoreInitializationError(message?): CoreInitializationError

Parameters

Returns

CoreInitializationError

Inherited from

Error.constructor

Constructor

new CoreInitializationError(message?, options?): CoreInitializationError

Parameters

Returns

CoreInitializationError

Inherited from

Error.constructor

Properties

name

readonly name: "CoreInitializationError" = "CoreInitializationError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when a synchronous operation that needs the loaded core runs before initializeCore() has completed.

Extends

• Error

Constructors

Constructor

new CoreNotReadyError(method?): CoreNotReadyError

Parameters

Returns

CoreNotReadyError

Overrides

Error.constructor

Properties

method

readonly method: string \| undefined

The public function that needed the core, when the caller knows it.

---

name

readonly name: "CoreNotReadyError" = "CoreNotReadyError"

Overrides

Error.name

---

realm

readonly realm: "main thread" \| "Web Worker" \| "Node"

The JavaScript realm that has no started core.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when the core loaded but failed its capability or version check.

This failure is final for the JavaScript realm (the page, worker or Node process): every later initializeCore call rejects with the same error, so a worker that sees it must end and a new worker must start. A plain CoreInitializationError (a failed fetch or compile) can be retried in the same realm. terminal lets a caller that only sees the error object tell the two apart. name stays "CoreInitializationError", so a check on the name still matches.

Extends

• CoreInitializationError

Constructors

Constructor

new CoreTerminalError(message?): CoreTerminalError

Parameters

Returns

CoreTerminalError

Inherited from

CoreInitializationError.constructor

Constructor

new CoreTerminalError(message?, options?): CoreTerminalError

Parameters

Returns

CoreTerminalError

Inherited from

CoreInitializationError.constructor

Properties

name

readonly name: "CoreInitializationError" = "CoreInitializationError"

Inherited from

CoreInitializationError.name

---

terminal

readonly terminal: true = true

---

Import from @infrared-city/infrared-sdk.

Reports an initialised core that lacks a function the SDK needs.

The SDK no longer throws this error: initializeCore() now refuses a mismatched core build before any operation runs. The class remains exported so existing catch and instanceof checks keep compiling.

Extends

• Error

Constructors

Constructor

new CoreVersionSkewError(missing): CoreVersionSkewError

Parameters

Returns

CoreVersionSkewError

Overrides

Error.constructor

Properties

name

readonly name: "CoreVersionSkewError" = "CoreVersionSkewError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

Thrown by parseEpw for an EPW file that cannot be used; the message gives the reason, and the original error is kept as cause.

Extends

• Error

Constructors

Constructor

new EpwParseError(message, options?): EpwParseError

Parameters

Returns

EpwParseError

Overrides

Error.constructor

---

Import from @infrared-city/infrared-sdk.

Thrown when the binary artifact of a facade batch would make the server place sensors on buildings that the run plan did not count.

It is raised before any upload or paid request, so nothing has been billed. missing lists planned target ids the artifact does not carry as targets, and unplanned lists artifact target ids that the plan did not count.

Extends

• Error

Constructors

Constructor

new FacadeArtifactMismatchError(analysisType, missing, unplanned): FacadeArtifactMismatchError

Parameters

Returns

FacadeArtifactMismatchError

Overrides

Error.constructor

Properties

analysisType

readonly analysisType: string

---

missing

readonly missing: readonly string\[\]

Planned target ids that the artifact does not carry as targets.

---

name

readonly name: "FacadeArtifactMismatchError" = "FacadeArtifactMismatchError"

Overrides

Error.name

---

unplanned

readonly unplanned: readonly string\[\]

Artifact target ids that the plan did not count.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when a facade retry is refused because the saved schedule's batches were sized with an older sensor-counting rule.

The schedule's finished tiles stay readable; start a fresh run to run the whole area again under the current rule.

Extends

• Error

Constructors

Constructor

new FacadeCountContractError(message): FacadeCountContractError

Parameters

Returns

FacadeCountContractError

Overrides

Error.constructor

---

Import from @infrared-city/infrared-sdk.

The optional Overture parquet packages are not installed.

hyparquet and hyparquet-compressors are optional peer dependencies: only the Overture reader loads them, so a caller who brings their own data never installs them. Everything else in the package (payloads, area runs over your own geometry, results, images, the static weather catalog and the FlatGeobuf layers) works without them.

The message names both packages and the exact install command, whichever of the two is missing, because installing only one is never the fix. There is no fallback decoder.

Extends

• GeodataError

Constructors

Constructor

new GeodataDependencyError(packageName, cause?): GeodataDependencyError

Parameters

Returns

GeodataDependencyError

Overrides

GeodataError.constructor

Properties

name

readonly name: "GeodataDependencyError" = "GeodataDependencyError"

Overrides

GeodataError.name

---

packageName

readonly packageName: string

The package that could not be loaded.

---

installCommand

readonly static installCommand: "npm install hyparquet hyparquet-compressors" = INSTALL_COMMAND

The command to run, so a caller can print it without parsing prose.

---

Import from @infrared-city/infrared-sdk.

Base class for every direct data-acquisition failure.

Catch this class to handle any error thrown by the geodata readers.

Extends

• Error

Extended by

• GeodataDependencyError
• GeodataFetchError
• GeodataRangeError
• HostNotAllowedError
• OvertureFileLimitError
• OvertureReadTooLargeError
• SiteReadError

Constructors

Constructor

new GeodataError(message?): GeodataError

Parameters

Returns

GeodataError

Inherited from

Error.constructor

Constructor

new GeodataError(message?, options?): GeodataError

Parameters

Returns

GeodataError

Inherited from

Error.constructor

Properties

name

readonly name: string = "GeodataError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

A public host answered in a way the reader cannot use.

status carries the HTTP status code when there was one.

Extends

• GeodataError

Constructors

Constructor

new GeodataFetchError(url, detail, status?, options?): GeodataFetchError

Parameters

Returns

GeodataFetchError

Overrides

GeodataError.constructor

Properties

name

readonly name: "GeodataFetchError" = "GeodataFetchError"

Overrides

GeodataError.name

---

status?

readonly optional status?: number

---

Import from @infrared-city/infrared-sdk.

A ranged read could not be trusted or would not fit.

Three cases, all of which must be loud: the object changed between two ranges of one read (If-Match → 412), a server answered a Range request with the whole object, or a whole-object read would exceed the caller's byte cap.

Extends

• GeodataError

Constructors

Constructor

new GeodataRangeError(url, detail, status?): GeodataRangeError

Parameters

Returns

GeodataRangeError

Overrides

GeodataError.constructor

Properties

name

readonly name: "GeodataRangeError" = "GeodataRangeError"

Overrides

GeodataError.name

---

status?

readonly optional status?: number

---

Import from @infrared-city/infrared-sdk.

Thrown when the API accepted a job that refers to previously uploaded geometry but did not return the acknowledgement that confirms the geometry was resolved.

It is not safe to retry; see GeometryReferenceSubmissionError.

Extends

• GeometryReferenceSubmissionError

Constructors

Constructor

new GeometryReferenceAcknowledgementError(acceptedJobIds?, reason?): GeometryReferenceAcknowledgementError

Parameters

Returns

GeometryReferenceAcknowledgementError

Overrides

GeometryReferenceSubmissionError.constructor

Properties

acceptedJobIds

readonly acceptedJobIds: readonly string\[\]

Ids of the jobs the API reported as accepted, without duplicates.

Inherited from

GeometryReferenceSubmissionError.acceptedJobIds

---

invalidReference

readonly invalidReference: true = true

Always true: the reference or its outcome cannot be used.

Inherited from

GeometryReferenceSubmissionError.invalidReference

---

name

readonly name: string = "GeometryReferenceAcknowledgementError"

Overrides

GeometryReferenceSubmissionError.name

---

nonRetryable

readonly nonRetryable: true = true

Always true: repeating the submission is not safe.

Inherited from

GeometryReferenceSubmissionError.nonRetryable

---

reason

readonly reason: string = "geometry-reference-outcome-uncertain"

Inherited from

GeometryReferenceSubmissionError.reason

---

Import from @infrared-city/infrared-sdk.

Thrown when a submission that refers to previously uploaded geometry may have created a job, but its outcome cannot be used.

It is not safe to retry. acceptedJobIds lists any jobs the API reported as accepted, so they can be reconciled against billing, and reason is a short machine-readable code for why the submission was refused.

Extends

• AcceptedResponseError

Extended by

• GeometryReferenceAcknowledgementError

Constructors

Constructor

new GeometryReferenceSubmissionError(acceptedJobIds?, reason?, message?): GeometryReferenceSubmissionError

Parameters

Returns

GeometryReferenceSubmissionError

Overrides

AcceptedResponseError.constructor

Properties

acceptedJobIds

readonly acceptedJobIds: readonly string\[\]

Ids of the jobs the API reported as accepted, without duplicates.

---

invalidReference

readonly invalidReference: true = true

Always true: the reference or its outcome cannot be used.

---

name

readonly name: string = "GeometryReferenceSubmissionError"

Overrides

AcceptedResponseError.name

---

nonRetryable

readonly nonRetryable: true = true

Always true: repeating the submission is not safe.

---

reason

readonly reason: string = "geometry-reference-outcome-uncertain"

---

Import from @infrared-city/infrared-sdk.

Thrown when a grid cannot be rendered locally, for example because it is empty, ragged or mixes text into a numeric result.

Extends

• Error

Constructors

Constructor

new GridImageError(message?): GridImageError

Parameters

Returns

GridImageError

Inherited from

Error.constructor

Constructor

new GridImageError(message?, options?): GridImageError

Parameters

Returns

GridImageError

Inherited from

Error.constructor

Properties

name

readonly name: "GridImageError" = "GridImageError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

A URL outside the public data allow-list was requested.

The allow-list is what keeps credentials off public objects and keeps a caller-supplied manifest from redirecting a range read at an arbitrary host.

Extends

• GeodataError

Constructors

Constructor

new HostNotAllowedError(url): HostNotAllowedError

Parameters

Returns

HostNotAllowedError

Overrides

GeodataError.constructor

Properties

name

readonly name: "HostNotAllowedError" = "HostNotAllowedError"

Overrides

GeodataError.name

---

Import from @infrared-city/infrared-sdk.

Thrown when an option is given a value the SDK does not support, or a removed option is passed. The message names what to use instead.

Extends

• TypeError

Constructors

Constructor

new InvalidOptionError(message?): InvalidOptionError

Parameters

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?, options?): InvalidOptionError

Parameters

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?): InvalidOptionError

Parameters

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?, options?): InvalidOptionError

Parameters

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Properties

name

readonly name: "InvalidOptionError" = "InvalidOptionError"

Overrides

TypeError.name

---

Import from @infrared-city/infrared-sdk.

Thrown when waiting for a job was cancelled through its AbortSignal.

Extends

• Error

Constructors

Constructor

new JobAbortedError(jobId): JobAbortedError

Parameters

Returns

JobAbortedError

Overrides

Error.constructor

Properties

jobId

readonly jobId: string

Id of the job that was being waited on.

---

name

readonly name: "JobAbortedError" = "JobAbortedError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

Thrown when a job finished with status failed.

Extends

• Error

Constructors

Constructor

new JobFailedError(jobId, errorMessage): JobFailedError

Parameters

Returns

JobFailedError

Overrides

Error.constructor

Properties

errorMessage

readonly errorMessage: string

The failure message reported for the job; may be empty.

---

jobId

readonly jobId: string

Id of the job that failed.

---

name

readonly name: "JobFailedError" = "JobFailedError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

Thrown when results are requested for a job that has not completed.

Extends

• Error

Constructors

Constructor

new JobNotCompletedError(jobId, status): JobNotCompletedError

Parameters

Returns

JobNotCompletedError

Overrides

Error.constructor

Properties

jobId

readonly jobId: string

Id of the job.

---

name

readonly name: "JobNotCompletedError" = "JobNotCompletedError"

Overrides

Error.name

---

status

readonly status: JobStatus

The status the job had when results were requested.

---

Import from @infrared-city/infrared-sdk.

Thrown when a status request was refused for good (for example HTTP 401 or 403), so the run cannot learn the state of its jobs.

Extends

• Error

Constructors

Constructor

new JobPollError(message, status): JobPollError

Parameters

Returns

JobPollError

Overrides

Error.constructor

Properties

name

readonly name: "JobPollError" = "JobPollError"

Overrides

Error.name

---

status

readonly status: number

The HTTP status of the refused status request.

---

Import from @infrared-city/infrared-sdk.

Thrown when waiting for a job ran past its timeout before the job finished.

Extends

• Error

Constructors

Constructor

new JobTimeoutError(jobId): JobTimeoutError

Parameters

Returns

JobTimeoutError

Overrides

Error.constructor

Properties

jobId

readonly jobId: string

Id of the job that was being waited on.

---

name

readonly name: "JobTimeoutError" = "JobTimeoutError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

More Overture files match an area than the maxFiles option allows.

Reading only the first N files would silently drop features everywhere in the area, so the read fails instead. The error names both counts and the caller decides whether to raise maxFiles or read a smaller area.

Extends

• GeodataError

Constructors

Constructor

new OvertureFileLimitError(collection, files, maxFiles): OvertureFileLimitError

Parameters

Returns

OvertureFileLimitError

Overrides

GeodataError.constructor

Properties

collection

readonly collection: string

The Overture collection being read, such as "building".

---

files

readonly files: number

Number of files that match the area.

---

maxFiles

readonly maxFiles: number

The maxFiles limit that was exceeded.

---

name

readonly name: "OvertureFileLimitError" = "OvertureFileLimitError"

Overrides

GeodataError.name

---

Import from @infrared-city/infrared-sdk.

An Overture read would move more compressed data than the runtime allows.

The amount to fetch is known from the parquet file footers before any data is fetched, so an area too large to decode fails up front. The error names the limit, the planned size and the rectangle it was planned for. Read a smaller area or raise maxPlannedBytes.

The limit applies to one call, not to each collection: an area read of several ground layers shares one limit.

Extends

• GeodataError

Constructors

Constructor

new OvertureReadTooLargeError(collection, plannedBytes, limitBytes, files, rowGroups, bbox): OvertureReadTooLargeError

Parameters

Returns

OvertureReadTooLargeError

Overrides

GeodataError.constructor

Properties

bbox

readonly bbox: object

The rectangle the read was planned for.

east

east: number

north

north: number

south

south: number

west

west: number

---

collection

readonly collection: string

The Overture collection being read, such as "building".

---

files

readonly files: number

Number of parquet files in the plan.

---

limitBytes

readonly limitBytes: number

The byte limit that was exceeded.

---

name

readonly name: "OvertureReadTooLargeError" = "OvertureReadTooLargeError"

Overrides

GeodataError.name

---

plannedBytes

readonly plannedBytes: number

Compressed bytes the read would have fetched.

---

rowGroups

readonly rowGroups: number

Number of row groups in the plan.

---

Import from @infrared-city/infrared-sdk.

Thrown when the parts of a run do not all finish within the timeout.

The parts are already submitted and billed. schedule holds the accepted jobs, so the run can be merged again later or passed as retryFrom.

Extends

• Error

Constructors

Constructor

new PartsTimeoutError(message, schedule): PartsTimeoutError

Parameters

Returns

PartsTimeoutError

Overrides

Error.constructor

Properties

name

readonly name: "PartsTimeoutError" = "PartsTimeoutError"

Overrides

Error.name

---

schedule

readonly schedule: PartsSchedule

The submitted parts run, with its accepted jobs.

---

Import from @infrared-city/infrared-sdk.

Thrown when the API price list cannot be fetched and the client has no earlier copy of it. A cost estimate needs a real price, so none is made up. The message names the URL and the cause.

Extends

• Error

Constructors

Constructor

new PricingUnavailableError(url, cause): PricingUnavailableError

Parameters

Returns

PricingUnavailableError

Overrides

Error.constructor

Properties

name

readonly name: "PricingUnavailableError" = "PricingUnavailableError"

Overrides

Error.name

---

url

readonly url: string

The price list URL that was fetched.

---

Import from @infrared-city/infrared-sdk.

Thrown when a run needs a wider read margin than the layer it was given was acquired with.

It carries both margins and both analysis types, so you can see what to re-acquire with. Re-acquire the layer with the analysis type the run needs, or with no analysis type at all, which reads the widest margin and is valid for every analysis.

Extends

• Error

Constructors

Constructor

new ReadMarginError(fields): ReadMarginError

Parameters

Returns

ReadMarginError

Overrides

Error.constructor

Properties

acquiredAnalysisType

readonly acquiredAnalysisType: string \| undefined

The analysis type the layer was acquired for, when recorded.

---

acquiredMarginM

readonly acquiredMarginM: number

The read margin, in metres, the layer was acquired with.

---

layer

readonly layer: string

The layer that was acquired too narrowly, for example "buildings".

---

requiredAnalysisType

readonly requiredAnalysisType: string \| undefined

The analysis type that sets the required margin.

---

requiredMarginM

readonly requiredMarginM: number

The read margin, in metres, the run needs.

---

Import from @infrared-city/infrared-sdk.

Thrown when the colour registry could not be fetched or its answer was not usable: a URL that is not HTTPS on the registry host, a redirect, an HTTP error, a timeout or abort, a body that is too large or not JSON, or a document without colour configurations.

Extends

• Error

Constructors

Constructor

new RegistryFetchError(message?): RegistryFetchError

Parameters

Returns

RegistryFetchError

Inherited from

Error.constructor

Constructor

new RegistryFetchError(message?, options?): RegistryFetchError

Parameters

Returns

RegistryFetchError

Inherited from

Error.constructor

Properties

name

readonly name: "RegistryFetchError" = "RegistryFetchError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk.

One read chunk that failed during a site read.

row and col are always -1: a site read fails by read chunk, not by simulation tile, so a chunk has no place in the simulation grid. The chunk id (tileId) is chunk-r{row}c{col}, row-major and zero-based.

Properties

---

Import from @infrared-city/infrared-sdk.

A site read in which at least one read chunk failed.

Every chunk feeds the site, so one failing chunk fails the whole read. A partial result would be an emptier city that nobody can see. failedTiles lists every chunk that failed, in row-major order.

cause is the first underlying failure in chunk order, for example an OvertureReadTooLargeError or a GeodataFetchError. Catch this class and read cause for the reason and failedTiles for which chunks failed.

Extends

• GeodataError

Constructors

Constructor

new SiteReadError(message, failedTiles, cause?): SiteReadError

Parameters

Returns

SiteReadError

Overrides

GeodataError.constructor

Properties

failedTiles

readonly failedTiles: readonly SiteChunkFailure\[\]

Every chunk that failed, in row-major order.

---

name

readonly name: "SiteReadError" = "SiteReadError"

Overrides

GeodataError.name

---

Import from @infrared-city/infrared-sdk.

Thrown when a job submission was sent but it is not certain whether the API created a job, so repeating it could be billed twice.

acceptedJobIds lists any job ids the API reported, so they can be checked or reconciled against billing. The SDK does not retry such a submission by itself.

Extends

• Error

Constructors

Constructor

new SubmissionUncertainError(acceptedJobIds, status?): SubmissionUncertainError

Parameters

Returns

SubmissionUncertainError

Overrides

Error.constructor

Properties

acceptedJobIds

readonly acceptedJobIds: readonly string\[\]

---

name

readonly name: "SubmissionUncertainError" = "SubmissionUncertainError"

Overrides

Error.name

---

phase

readonly phase: "unknown-acceptance" = "unknown-acceptance"

Always "unknown-acceptance".

---

status

readonly status: number \| undefined

The HTTP status when the answer was a redirect (3xx) or a server error (5xx), otherwise undefined.

---

Import from @infrared-city/infrared-sdk.

const TILE\_FAILURE\_KINDS: readonly \["send_refused", "host_refused", "rate_limited", "payment_required", "uncertain", "server_failed", "download_failed", "timeout"\]

Why a tile has no result: the kinds of the SDK core. retryPolicy().failureAdvice[kind] says what to do.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

A tile that did not contribute to the merged grid, and why.

Properties

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

TileFailureKind = typeof TILE_FAILURE_KINDS\[number\]

Why a tile has no result: one of the kinds retryPolicy().failureAdvice names.

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

TileFailurePhase = typeof TileFailurePhase\keyof typeof [TileFailurePhase\]

The stage at which a tile failed or was skipped.

const TileFailurePhase: object

The stage at which a tile failed or was skipped: Submit, Compute, Download or Skipped.

Type Declaration

---

Import from @infrared-city/infrared-sdk.

Thrown when a vegetation operation fails in a way the caller must see, for example a malformed feature collection or a failed conversion.

Extends

• Error

Constructors

Constructor

new VegetationMeshError(message?): VegetationMeshError

Parameters

Returns

VegetationMeshError

Inherited from

Error.constructor

Constructor

new VegetationMeshError(message?, options?): VegetationMeshError

Parameters

Returns

VegetationMeshError

Inherited from

Error.constructor

Properties

name

readonly name: "VegetationMeshError" = "VegetationMeshError"

Overrides

Error.name

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/tiling.

Thrown when a retry is refused because its weather cannot be shown to be the weather the original run used, or because a weather-bearing payload cannot be identified at all.

Start a fresh run, or build the retry payload from the same weather: the same file, catalog window or arrays.

Extends

• Error

Constructors

Constructor

new WeatherIdentityError(message): WeatherIdentityError

Parameters

Returns

WeatherIdentityError

Overrides

Error.constructor

---

Import from @infrared-city/infrared-sdk.

Thrown when a weather document cannot supply what the requested analysis needs for the requested time window; the message gives the reason, and the original error is kept as cause.

Extends

• Error

Constructors

Constructor

new WeatherModelInputsError(message, options?): WeatherModelInputsError

Parameters

Returns

WeatherModelInputsError

Overrides

Error.constructor

---

Import from @infrared-city/infrared-sdk, @infrared-city/infrared-sdk/utilities.

Thrown when a weather read fails.

statusCode is an HTTP-style status and operation names the call that failed. A malformed catalog, a body that is not JSON and a refused answer are all 502: the weather host was reached but its answer was unusable.

Extends

• Error

Constructors

Constructor

new WeatherServiceError(message, statusCode, operation): WeatherServiceError

Parameters

Returns

WeatherServiceError

Overrides

Error.constructor

Properties

name

readonly name: "WeatherServiceError" = "WeatherServiceError"

Overrides

Error.name

---

operation

readonly operation: string

---

statusCode

readonly statusCode: number

---