Errors

AnalysisPartsError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Default value	Description
`message`	`string`	`undefined`	What went wrong.
`failedParts`	readonly `string`[]	`undefined`	Parts a `retryFrom` sends again; empty when every part has a result.
`schedule`	`PartsSchedule`	`undefined`	The run, with its accepted jobs.
`downloadFailedParts`	readonly `string`[]	`[]`	Parts whose result is on the server but did not download: `mergeParts(schedule)` (or a `retryFrom`, which then sends nothing) downloads them again.
`options?`	`ErrorOptions`	`undefined`	Standard error options, such as `cause`.

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.

AreaGeometryProbeError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`areaSchedule`	`AreaSchedule`
`acceptedProbeJobIds`	readonly `string`[]

Returns

AreaGeometryProbeError

Overrides

Error.constructor

Properties

acceptedProbeJobIds

readonly acceptedProbeJobIds: readonly string[]

areaSchedule

readonly areaSchedule: AreaSchedule

name

readonly name: "AreaGeometryProbeError" = "AreaGeometryProbeError"

Overrides

Error.name

AreaGeometryReferenceError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`areaSchedule`	`AreaSchedule`
`acceptedJobIds`	readonly `string`[]

Returns

AreaGeometryReferenceError

Overrides

Error.constructor

Properties

acceptedJobIds

readonly acceptedJobIds: readonly string[]

areaSchedule

readonly areaSchedule: AreaSchedule

name

readonly name: "AreaGeometryReferenceError" = "AreaGeometryReferenceError"

Overrides

Error.name

AreaTimeoutError

Import from @infrared-city/infrared-sdk-ts.

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

Extends

Error

Constructors

Constructor

new AreaTimeoutError(message, areaState): AreaTimeoutError

Parameters

Parameter	Type	Description
`message`	`string`	The error message.
`areaState`	`AreaState`	The run's counts at the moment it timed out.

Returns

AreaTimeoutError

Overrides

Error.constructor

Properties

areaState

readonly areaState: AreaState

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

ConfigHashPolicyError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message`	`string`

Returns

ConfigHashPolicyError

Overrides

Error.constructor

CoreInitializationError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message?`	`string`

Returns

CoreInitializationError

Inherited from

Error.constructor

Constructor

new CoreInitializationError(message?, options?): CoreInitializationError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

CoreInitializationError

Inherited from

Error.constructor

Properties

name

readonly name: "CoreInitializationError" = "CoreInitializationError"

Overrides

Error.name

CoreNotReadyError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`method?`	`string`

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.

CoreTerminalError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message?`	`string`

Returns

CoreTerminalError

Inherited from

CoreInitializationError.constructor

Constructor

new CoreTerminalError(message?, options?): CoreTerminalError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

CoreTerminalError

Inherited from

CoreInitializationError.constructor

Properties

name

readonly name: "CoreInitializationError" = "CoreInitializationError"

Inherited from

CoreInitializationError.name

terminal

readonly terminal: true = true

CoreVersionSkewError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`missing`	readonly `string`[]

Returns

CoreVersionSkewError

Overrides

Error.constructor

Properties

name

readonly name: "CoreVersionSkewError" = "CoreVersionSkewError"

Overrides

Error.name

EpwParseError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`message`	`string`	The reason the file was refused.
`options?`	{ `cause?`: `unknown`; }	`cause` is the underlying error.
`options.cause?`	`unknown`	-

Returns

EpwParseError

Overrides

Error.constructor

FacadeArtifactMismatchError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`analysisType`	`string`	-
`missing`	readonly `string`[]	Planned target ids that the artifact does not carry as targets.
`unplanned`	readonly `string`[]	Artifact target ids that the plan did not count.

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.

FacadeCountContractError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message`	`string`

Returns

FacadeCountContractError

Overrides

Error.constructor

GeodataDependencyError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`packageName`	`string`
`cause?`	`unknown`

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.

GeodataError

Import from @infrared-city/infrared-sdk-ts.

Base class for every direct data-acquisition failure.

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

Extends

Error

Extended by

Constructors

Constructor

new GeodataError(message?): GeodataError

Parameters

Parameter	Type
`message?`	`string`

Returns

GeodataError

Inherited from

Error.constructor

Constructor

new GeodataError(message?, options?): GeodataError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

GeodataError

Inherited from

Error.constructor

Properties

name

readonly name: string = "GeodataError"

Overrides

Error.name

GeodataFetchError

Import from @infrared-city/infrared-sdk-ts.

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?): GeodataFetchError

Parameters

Parameter	Type
`url`	`string`
`detail`	`string`
`status?`	`number`

Returns

GeodataFetchError

Overrides

GeodataError.constructor

Properties

name

readonly name: "GeodataFetchError" = "GeodataFetchError"

Overrides

GeodataError.name

status?

readonly optional status?: number

GeodataRangeError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`url`	`string`
`detail`	`string`
`status?`	`number`

Returns

GeodataRangeError

Overrides

GeodataError.constructor

Properties

name

readonly name: "GeodataRangeError" = "GeodataRangeError"

Overrides

GeodataError.name

status?

readonly optional status?: number

GeometryReferenceAcknowledgementError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Default value
`acceptedJobIds`	readonly `string`[]	`[]`
`reason`	`string`	`"invalid-geometry-acknowledgement"`

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

GeometryReferenceSubmissionError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Default value
`acceptedJobIds`	readonly `string`[]	`[]`
`reason`	`string`	`"geometry-reference-outcome-uncertain"`
`message`	`string`	`"geometry-reference submission cannot be used or retried safely"`

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"

GridImageError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`message?`	`string`

Returns

GridImageError

Inherited from

Error.constructor

Constructor

new GridImageError(message?, options?): GridImageError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

GridImageError

Inherited from

Error.constructor

Properties

name

readonly name: "GridImageError" = "GridImageError"

Overrides

Error.name

HostNotAllowedError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`url`	`string`

Returns

HostNotAllowedError

Overrides

GeodataError.constructor

Properties

name

readonly name: "HostNotAllowedError" = "HostNotAllowedError"

Overrides

GeodataError.name

InvalidOptionError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`message?`	`string`

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?, options?): InvalidOptionError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?): InvalidOptionError

Parameters

Parameter	Type
`message?`	`string`

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Constructor

new InvalidOptionError(message?, options?): InvalidOptionError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

InvalidOptionError

Inherited from

TypeError.constructor

Properties

name

readonly name: "InvalidOptionError" = "InvalidOptionError"

Overrides

TypeError.name

JobAbortedError

Import from @infrared-city/infrared-sdk-ts.

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

Extends

Error

Constructors

Constructor

new JobAbortedError(jobId): JobAbortedError

Parameters

Parameter	Type	Description
`jobId`	`string`	Id of the job that was being waited on.

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

JobFailedError

Import from @infrared-city/infrared-sdk-ts.

Thrown when a job finished with status failed.

Extends

Error

Constructors

Constructor

new JobFailedError(jobId, errorMessage): JobFailedError

Parameters

Parameter	Type	Description
`jobId`	`string`	Id of the job that failed.
`errorMessage`	`string`	The failure message reported for the job; may be empty.

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

JobNotCompletedError

Import from @infrared-city/infrared-sdk-ts.

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

Extends

Error

Constructors

Constructor

new JobNotCompletedError(jobId, status): JobNotCompletedError

Parameters

Parameter	Type	Description
`jobId`	`string`	Id of the job.
`status`	`JobStatus`	The status the job had when results were requested.

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.

JobTimeoutError

Import from @infrared-city/infrared-sdk-ts.

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

Extends

Error

Constructors

Constructor

new JobTimeoutError(jobId): JobTimeoutError

Parameters

Parameter	Type	Description
`jobId`	`string`	Id of the job that was being waited on.

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

OvertureFileLimitError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`collection`	`string`	The Overture collection being read, such as `"building"`.
`files`	`number`	Number of files that match the area.
`maxFiles`	`number`	The `maxFiles` limit that was exceeded.

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

OvertureReadTooLargeError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`collection`	`string`	The Overture collection being read, such as `"building"`.
`plannedBytes`	`number`	Compressed bytes the read would have fetched.
`limitBytes`	`number`	The byte limit that was exceeded.
`files`	`number`	Number of parquet files in the plan.
`rowGroups`	`number`	Number of row groups in the plan.
`bbox`	{ `east`: `number`; `north`: `number`; `south`: `number`; `west`: `number`; }	The rectangle the read was planned for.
`bbox.east`	`number`	-
`bbox.north`	`number`	-
`bbox.south`	`number`	-
`bbox.west`	`number`	-

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.

PartsTimeoutError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`message`	`string`	What timed out and how many parts had finished.
`schedule`	`PartsSchedule`	The submitted parts run, with its accepted jobs.

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.

ReadMarginError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`fields`	{ `acquiredAnalysisType?`: `string`; `acquiredMarginM`: `number`; `layer`: `string`; `requiredAnalysisType?`: `string`; `requiredMarginM`: `number`; }
`fields.acquiredAnalysisType?`	`string`
`fields.acquiredMarginM`	`number`
`fields.layer`	`string`
`fields.requiredAnalysisType?`	`string`
`fields.requiredMarginM`	`number`

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.

RegistryFetchError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`message?`	`string`

Returns

RegistryFetchError

Inherited from

Error.constructor

Constructor

new RegistryFetchError(message?, options?): RegistryFetchError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

RegistryFetchError

Inherited from

Error.constructor

Properties

name

readonly name: "RegistryFetchError" = "RegistryFetchError"

Overrides

Error.name

SiteChunkFailure

Import from @infrared-city/infrared-sdk-ts.

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

Property	Modifier	Type	Description
`col`	`readonly`	`number`	Always `-1`.
`error`	`readonly`	`string`	The failure message of that chunk.
`row`	`readonly`	`number`	Always `-1`.
`tileId`	`readonly`	`string`	The chunk id, `chunk-r{row}c{col}`.

SiteReadError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`message`	`string`	-
`failedTiles`	readonly `SiteChunkFailure`[]	Every chunk that failed, in row-major order.
`cause?`	`unknown`	-

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

SubmissionUncertainError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`acceptedJobIds`	readonly `string`[]
`status?`	`number`

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.

TileFailure

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

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

Properties

Property	Modifier	Type	Description
`col`	`readonly`	`number`	Column of the tile in the tile grid.
`error`	`readonly`	`string`	A description of what went wrong.
`exception?`	`readonly`	`Error`	The underlying error, when there was one.
`phase?`	`readonly`	`TileFailurePhase`	The stage at which the tile failed.
`row`	`readonly`	`number`	Row of the tile in the tile grid.
`tileId`	`readonly`	`string`	Identifier of the tile.

TileFailurePhase

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Name	Type	Default value
`Compute`	`"compute"`	`"compute"`
`Download`	`"download"`	`"download"`
`Skipped`	`"skipped"`	`"skipped"`
`Submit`	`"submit"`	`"submit"`

VegetationMeshError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type
`message?`	`string`

Returns

VegetationMeshError

Inherited from

Error.constructor

Constructor

new VegetationMeshError(message?, options?): VegetationMeshError

Parameters

Parameter	Type
`message?`	`string`
`options?`	`ErrorOptions`

Returns

VegetationMeshError

Inherited from

Error.constructor

Properties

name

readonly name: "VegetationMeshError" = "VegetationMeshError"

Overrides

Error.name

WeatherIdentityError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message`	`string`

Returns

WeatherIdentityError

Overrides

Error.constructor

WeatherModelInputsError

Import from @infrared-city/infrared-sdk-ts.

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

Parameter	Type	Description
`message`	`string`	The reason the document cannot serve the request.
`options?`	{ `cause?`: `unknown`; }	`cause` is the underlying error.
`options.cause?`	`unknown`	-

Returns

WeatherModelInputsError

Overrides

Error.constructor

WeatherServiceError

Import from @infrared-city/infrared-sdk-ts, @infrared-city/infrared-sdk-ts/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

Parameter	Type
`message`	`string`
`statusCode`	`number`
`operation`	`string`

Returns

WeatherServiceError

Overrides

Error.constructor

Properties

name

readonly name: "WeatherServiceError" = "WeatherServiceError"

Overrides

Error.name

operation

readonly operation: string

statusCode

readonly statusCode: number