netstorage/dist/src/operations/stat.d.ts

A TypeScript API and CLI for the Akamai NetStorage REST interface

import { type NetStorageClientConfig, type NetStorageFile, type RequestOptions } from '../index';
/**
 * Represents the result of a NetStorage `stat` response.
 *
 * @property file - Metadata for a file or files if present.
 * @property directory - Path of the directory if applicable.
 */
export interface NetStorageStat {
    stat: {
        file?: NetStorageFile | NetStorageFile[];
        directory?: string;
    };
}
/**
 * Parameters for performing a `stat` operation.
 *
 * @property path - Path to the file or directory to inspect.
 * @property options - Optional request configuration.
 */
export interface StatParams {
    path: string;
    options?: RequestOptions;
}
/**
 * Retrieves metadata for a file or directory in NetStorage.
 *
 * @param config - config including credentials, configuration, and logger.
 * @param params - Object with the target path and optional request options.
 * @returns A promise resolving to file or directory metadata.
 */
export declare function stat(config: NetStorageClientConfig, { path, options }: StatParams): Promise<NetStorageStat>;