@starfetch-js/core - npm Package Compare versions

Comparing version 0.2.3 to 0.3.0

dist/index.d.ts

@@ -76,3 +76,5 @@ //#region packages/core/src/tap-presets.d.ts
   json(): Promise<TapRow[]>; /** Stream supported rows as row objects. */
-  rows(): AsyncIterable<TapRow>; /** Read the result body as raw bytes. */
+  rows(): AsyncIterable<TapRow>; /** Read ordered result fields and available source metadata. */
+  fields(): Promise<TapResultField[]>; /** Report TAP `QUERY_STATUS=OVERFLOW` when the result format exposes it. */
+  overflow(): Promise<boolean | undefined>; /** Read the result body as raw bytes. */
   arrayBuffer(): Promise<ArrayBuffer>; /** Return a clone of the underlying web `Response`. */
@@ -82,2 +84,11 @@ response(): Response; /** Save the result body to a filesystem path in Node-compatible runtimes. */
 };
+/** Ordered field metadata exposed by a TAP query result. */
+type TapResultField = {
+  name: string;
+  datatype?: string;
+  unit?: string;
+  ucd?: string;
+  utype?: string;
+  description?: string;
+};
 /**
@@ -180,6 +191,6 @@ * Format a TAP result for CLI or adapter output.
   url: string; /** Read the current UWS job phase and result/error links. */
-  status(): Promise<TapJobStatus>; /** Poll until the job completes or a wait condition fails. */
+  status(options?: Pick<QueryOptions, "signal">): Promise<TapJobStatus>; /** Poll until the job completes or a wait condition fails. */
   wait(options?: TapJobWaitOptions): Promise<TapJobStatus>; /** Fetch the primary TAP result from the completed job. */
   fetch(options?: TapJobFetchOptions): Promise<TapResult>; /** Request job cleanup through the UWS job URL. */
-  delete(): Promise<void>;
+  delete(options?: Pick<QueryOptions, "signal">): Promise<void>;
 };
@@ -448,2 +459,2 @@ /** Async TAP job operations bound to a TAP client target. */
 //#endregion
-export { type QueryOptions, type ResolvedTapTarget, StarfetchError, TapAuthUnsupportedError, type TapAvailability, type TapCapabilities, type TapCellValue, TapClient, TapClientOptions, type TapColumn, TapFormatUnsupportedError, TapHttpError, type TapJob, type TapJobFetchOptions, type TapJobReference, type TapJobStatus, TapJobTerminalError, TapJobTimeoutError, type TapJobWaitOptions, type TapJobsClient, type TapOutputFormat, TapParseError, type TapPreset, type TapPresetRegistry, type TapRegistryClient, type TapRegistryOptions, type TapRegistrySearchOptions, type TapRegistryService, type TapRequestOptions, type TapResult, type TapRow, TapServiceError, type TapServiceFormat, type TapSyncFormat, type TapTable, type TapTarget, type TapUpload, TapUploadError, type TapUploadInline, type TapUploadUri, type VotableCellValue, type VotableDocument, type VotableField, type VotableInfo, type VotableRow, assertSupportedSyncFormat, buildTapQueryBody, buildTapQueryParams, defaultRegistryUrl, defaultTapPresets, formatTapResult, packageName, parseTapJobReference, parseVotable, registry, resolveTapTarget, tap, tapOutputFormats, tapRequestFormatForOutput, tapServiceFormats, tapSyncFormats };
+export { type QueryOptions, type ResolvedTapTarget, StarfetchError, TapAuthUnsupportedError, type TapAvailability, type TapCapabilities, type TapCellValue, TapClient, TapClientOptions, type TapColumn, TapFormatUnsupportedError, TapHttpError, type TapJob, type TapJobFetchOptions, type TapJobReference, type TapJobStatus, TapJobTerminalError, TapJobTimeoutError, type TapJobWaitOptions, type TapJobsClient, type TapOutputFormat, TapParseError, type TapPreset, type TapPresetRegistry, type TapRegistryClient, type TapRegistryOptions, type TapRegistrySearchOptions, type TapRegistryService, type TapRequestOptions, type TapResult, type TapResultField, type TapRow, TapServiceError, type TapServiceFormat, type TapSyncFormat, type TapTable, type TapTarget, type TapUpload, TapUploadError, type TapUploadInline, type TapUploadUri, type VotableCellValue, type VotableDocument, type VotableField, type VotableInfo, type VotableRow, assertSupportedSyncFormat, buildTapQueryBody, buildTapQueryParams, defaultRegistryUrl, defaultTapPresets, formatTapResult, packageName, parseTapJobReference, parseVotable, registry, resolveTapTarget, tap, tapOutputFormats, tapRequestFormatForOutput, tapServiceFormats, tapSyncFormats };

package.json

 {
   "name": "@starfetch-js/core",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "TypeScript library for querying Gaia, SIMBAD, VizieR, and other public astronomy TAP services with reproducible ADQL.",
@@ -61,3 +61,3 @@ "type": "module",
   },
-  "gitHead": "5169c9e9b9b52410c80f7cc8452fffb97ed27164"
+  "gitHead": "3149762e7d952737cbda7edda071af38f061640a"
 }

README.md

@@ -24,2 +24,4 @@ # @starfetch-js/core
 console.log(columns.length);
+console.log(await result.fields());
+console.log(await result.overflow());
 console.log(await result.json());
@@ -26,0 +28,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

187552

1.02%

Lines of code

4850

1.02%

Number of lines in readme file

35

6.06%

No dependency changes