@k8ts/instruments
Version:
A collection of utilities and core components for k8ts.
37 lines • 1.88 kB
TypeScript
import { DoddleAsync } from "doddle";
import { Map } from "immutable";
import StackTracey from "stacktracey";
export type LocalFileMode = "text" | "binary";
export interface LocalFileSourceProps<Mode extends LocalFileMode = "text"> {
pointOfCall: StackTracey;
path: string;
cwd?: string;
mode?: Mode;
}
export declare class LocalFileSource<Mode extends LocalFileMode = "text"> {
private readonly _props;
constructor(_props: LocalFileSourceProps<Mode>);
get cwd(): string;
get path(): string;
contents: DoddleAsync<Mode extends "text" ? string : Uint8Array>;
}
export declare function localFile<Mode extends LocalFileMode = "text">(path: string, props?: Pick<LocalFileSourceProps<Mode>, "cwd" | "mode">): LocalFileSource<Mode>;
export declare function localFile(args: TemplateStringsArray, ...params: any[]): LocalFileSource<"text">;
export interface TypedArrayLike {
buffer: ArrayBuffer;
byteLength: number;
}
export type DataSource_Text = LocalFileSource<"text"> | string;
export type DataSource_Binary = LocalFileSource<"binary"> | TypedArrayLike | ArrayBuffer;
export type DataSourceRecord_Text = Record<string, DataSource_Text>;
export type DataSourceRecord_Binary = Record<string, DataSource_Binary>;
export type DataSourceRecord = DataSourceRecord_Text | DataSourceRecord_Binary;
export declare function isTypedArray(data: DataSource_Binary): data is TypedArrayLike;
export declare function isArrayBuffer(data: DataSource_Binary): data is ArrayBuffer;
export interface DataSourceResolvedRecord {
data: Record<string, string>;
binaryData: Record<string, Uint8Array>;
}
export declare function resolveText(record: DataSourceRecord_Text): Promise<Map<string, string>>;
export declare function resolveBinary(record: DataSourceRecord_Binary): Promise<Map<string, Uint8Array<ArrayBuffer>>>;
//# sourceMappingURL=index.d.ts.map