Type Alias: ModelDownloaderOptions

type ModelDownloaderOptions = 
  | {
  modelUri: string;
 }
  | {} & {
  dirPath: string;
  fileName: string;
  headers: Record<string, string>;
  showCliProgress: boolean;
  onProgress: (status: {
     totalSize: number;
     downloadedSize: number;
    }) => void;
  skipExisting: boolean;
  deleteTempFileOnCancel: boolean;
  parallelDownloads: number;
  tokens: ModelFileAccessTokens;
};

Defined in: utils/createModelDownloader.ts:16

Type declaration

dirPath?

optional dirPath: string;

The directory to save the model file to. Default to node-llama-cpp's default global models directory (~/.node-llama-cpp/models).

fileName?

optional fileName: string;

headers?

optional headers: Record<string, string>;

showCliProgress?

optional showCliProgress: boolean;

Defaults to false.

onProgress()?

optional onProgress: (status: {
  totalSize: number;
  downloadedSize: number;
 }) => void;

Parameters

Parameter	Type
status	{ totalSize: number; downloadedSize: number; }
status.totalSize	number
status.downloadedSize	number

Returns

void

skipExisting?

optional skipExisting: boolean;

If true, the downloader will skip the download if the file already exists, and its size matches the size of the remote file.

Defaults to true.

deleteTempFileOnCancel?

optional deleteTempFileOnCancel: boolean;

If true, the temporary file will be deleted when the download is canceled.

Defaults to true.

parallelDownloads?

optional parallelDownloads: number;

The number of parallel downloads to use when downloading split files.

Defaults to 4.

tokens?

optional tokens: ModelFileAccessTokens;