@stryke/types/dist/file.d.cts

A package containing many base TypeScript type definitions that are shared across many projects.

import { ValidationDetail } from "./validations.cjs";

//#region src/file.d.ts
type FileStatus = "initialized" | "validated" | "uploaded" | "failed";
/**
 * A type that representing a file object.
 */
type FileResult = {
  name: string;
  status: FileStatus;
  issues?: ValidationDetail[];
  size?: number;
  mimeType?: string;
  lastModified?: number;
} & ({
  uri: string;
  file?: File;
} | {
  uri?: string;
  file: File;
});
/**
 * A valid `picomatch` glob pattern, or array of patterns.
 */
type FilterPattern = ReadonlyArray<string | RegExp> | string | RegExp | null;
interface FileInputOutput {
  input: string;
  output: string;
}
/**
 * An interface got representing an asset files with glob patterns.
 */
type AssetGlob = Required<Omit<FileInputOutput, "input">> & Partial<Pick<FileInputOutput, "input">> & {
  /**
   * A glob pattern to match files.
   */
  glob: string;
  /**
   * An array of glob patterns to ignore files.
   */
  ignore?: string[];
  /**
   * Include `.dot` files in normal matches and `globstar` matches. Note that an explicit dot in a portion of the pattern will always match dot files.
   *
   * @defaultValue true
   */
  dot?: boolean;
};
//#endregion
export { AssetGlob, FileInputOutput, FileResult, FileStatus, FilterPattern };
//# sourceMappingURL=file.d.cts.map