UNPKG

@discoveryjs/discovery

Version:

Frontend framework for rapid data (JSON) analysis, shareable serverless reports and dashboards

36 lines (35 loc) 2.46 kB
import type { Progressbar } from './progressbar.js'; import type { Encoding, LoadDataRequest, LoadDataResourceMetadata, LoadDataResourceSource, Dataset, LoadDataState, LoadDataResult, LoadDataBaseOptions, LoadDataFetchOptions, ExtractResourceOptions, LoadDataStateProgress, LoadDataFromPush } from './load-data.types.js'; import { Observer } from '../observer.js'; export type * from './load-data.types.js'; export declare const dataSource: { stream: typeof loadDataFromStream; event: typeof loadDataFromEvent; file: typeof loadDataFromFile; url: typeof loadDataFromUrl; push: typeof loadDataFromPush; }; export declare function dataFromStream(stream: ReadableStream<Uint8Array>, extraEncodings: Encoding[] | undefined, totalSize: number | undefined, setStageProgress: (stage: 'receiving' | 'decoding', progress?: LoadDataStateProgress, step?: string) => Promise<boolean>): Promise<{ data: any; compression: false | string; encoding: string; size: number; decodingTime: number; }>; export declare function createLoadDataState<T extends Record<string, unknown>>(datasetFactory: (state: Observer<LoadDataState>) => Promise<Dataset>, extra?: T): LoadDataResult & T; export declare function createDatasetFactoryFromStreamRequest(request: LoadDataRequest): (state: Observer<LoadDataState>) => Promise<Dataset>; export declare function loadDataFromStream(stream: ReadableStream, options?: LoadDataBaseOptions): LoadDataResult & Record<string, unknown>; export declare function loadDataFromFile(file: File, options?: LoadDataBaseOptions): LoadDataResult & { title: string; }; export declare function loadDataFromEvent(event: DragEvent | ClipboardEvent | InputEvent, options?: LoadDataBaseOptions): LoadDataResult & { title: string; }; export declare function loadDataFromUrl(url: string, options?: LoadDataFetchOptions): LoadDataResult & { title: string; }; export declare function loadDataFromPush(options?: LoadDataBaseOptions): LoadDataFromPush; export declare function syncLoaderWithProgressbar({ dataset, state }: LoadDataResult, progressbar: Progressbar): Promise<Dataset>; export declare function extractResourceMetadata(source: LoadDataResourceSource, options?: ExtractResourceOptions): LoadDataResourceMetadata | undefined; export declare function convertToBlobIfPossible(source: any): any; export declare function getReadableStreamFromSource(source: unknown): ReadableStream<Uint8Array<ArrayBufferLike>>;