Interface CogDecoder`Experimental`

Minimal structurally typed decoder contract. A GeoTIFF implementation can be adapted here without becoming a static dependency of the SDK.

interface CogDecoder {
    dispose?(): void | Promise<void>;
    inspect(context: CogDecoderInspectContext): Promise<CogDecodedMetadata>;
    readWindow(
        request: CogWindowRequest,
        context: CogDecoderReadContext,
    ): Promise<CogDecodedWindow>;
}

Index

Methods

dispose? inspect readWindow

Methods

`Optional`dispose

dispose?(): void | Promise<void>
Experimental
Returns void | Promise<void>
- Defined in work/honua-sdk-js/honua-sdk-js/src/cog/types.ts:155

inspect

inspect(context: CogDecoderInspectContext): Promise<CogDecodedMetadata>
Experimental
Parameters
- context: CogDecoderInspectContext
Returns Promise<CogDecodedMetadata>
- Defined in work/honua-sdk-js/honua-sdk-js/src/cog/types.ts:153

readWindow

readWindow(
request: CogWindowRequest,
context: CogDecoderReadContext,
): Promise<CogDecodedWindow>
Experimental
Parameters
- request: CogWindowRequest
- context: CogDecoderReadContext
Returns Promise<CogDecodedWindow>
- Defined in work/honua-sdk-js/honua-sdk-js/src/cog/types.ts:154